GeoGebra Reference Guide

https://geogebra.github.io/docs/reference/en
Admin
The GeoGebra Reference Guide provides technical information for developers (Apps Embedding, Apps...
Tokens:38,435
Snippets:299
Trust Score:8.3
Update:8 months ago
Show doc for...
Tokens:
Raw
### Load GeoGebra File (Java)

Source: https://geogebra.github.io/docs/reference/en/Command_Line_Arguments

This command starts GeoGebra and immediately loads a specified GeoGebra file (`.ggb`). It includes memory allocation and encoding settings for a smooth loading process.

```shell
.\jre\bin\java -Xms32m -Xmx1024m -Dsun.jnu.encoding=UTF-8 -jar geogebra.jar myfile.ggb
```

--------------------------------

### Run GeoGebra on Windows (Offline Installer)

Source: https://geogebra.github.io/docs/reference/en/Command_Line_Arguments

This is the command to run GeoGebra on Windows if it was installed using the offline installer. It allows for specifying options and opening files directly from the command line.

```shell
geogebra.exe [OPTIONS] [FILES]
```

--------------------------------

### File Format Methods

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

Methods for getting and setting GeoGebra constructions in various formats like XML, JSON, and base64.

```APIDOC
## File Format Methods

### `evalXML(xmlString)`

#### Description
Evaluates the given XML string and changes the current construction. The construction is NOT cleared before evaluating the XML string.

#### Method
`void evalXML(String xmlString)`

#### Parameters
- **xmlString** (String) - Required - The XML string to evaluate.

### `setXML(xmlString)`

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

#### Method
`void setXML(String xmlString)`

#### Parameters
- **xmlString** (String) - Required - The XML string to set.

### `getXML()`

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

#### Method
`String getXML()`

### `getXML(objName)`

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

#### Method
`String getXML(String objName)`

#### Parameters
- **objName** (String) - Required - The name of the object.

### `getAlgorithmXML(objName)`

#### Description
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.

#### Method
`String getAlgorithmXML(String objName)`

#### Parameters
- **objName** (String) - Required - The name of the GeoElement.

### `getFileJSON()`

#### Description
Gets the current construction as JSON object including the XML and images.

#### Method
`String getFileJSON()`

### `setFileJSON(content)`

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

#### Method
`String setFileJSON(Object content)`

#### Parameters
- **content** (Object) - Required - The JSON content to set.

### `getBase64()`

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

#### Method
`String getBase64()`

### `getBase64(callback)`

#### Description
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).

#### Method
`String getBase64(function callback)`

#### Parameters
- **callback** (function) - Required - The callback function to execute with the base64 string.

### `setBase64(string, [callback])`

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

#### Method
`void setBase64(String [, function callback] )`

#### Parameters
- **string** (String) - Required - The base64-encoded .ggb file string.
- **callback** (function) - Optional - The callback function to execute after loading.

```

--------------------------------

### Run GeoGebra on Linux (Package Install)

Source: https://geogebra.github.io/docs/reference/en/Command_Line_Arguments

This is the command to run GeoGebra on Linux after installation via deb or rpm packages. It allows for specifying options and opening files directly from the command line.

```shell
geogebra [OPTIONS] [FILES]
```

--------------------------------

### Start GeoGebra in a Specific Language (Java)

Source: https://geogebra.github.io/docs/reference/en/Command_Line_Arguments

This command launches GeoGebra and sets the user interface language according to the provided ISO language code. The `--language` option followed by the locale code (e.g., `de_AT` for Austrian German) controls the language setting. Memory allocation and encoding are also configured.

```shell
.\jre\bin\java -Xms32m -Xmx1024m -Dsun.jnu.encoding=UTF-8 -jar geogebra.jar --language=de_AT
```

--------------------------------

### Install GeoGebra Service Worker (JavaScript)

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_Embedding

This JavaScript code snippet checks for service worker support in the browser and installs the GeoGebra service worker. It caches application scripts for faster loading on subsequent visits. Ensure `sworker-locked.js` is accessible and configure `serviceWorkerPath` and `appletLocation` appropriately.

```javascript
   var serviceWorkerPath = '/sworker-locked.js'
   var appletLocation = '/'

   function isServiceWorkerSupported() {
       return 'serviceWorker' in navigator && location.protocol === "https:";
   }

   function installServiceWorker() {
       if (navigator.serviceWorker.controller) {
           console.log("Service worker is already controlling the page.");
       } else {
           navigator.serviceWorker.register(serviceWorkerPath, {
               scope: appletLocation
           });
       }
   }

   if (isServiceWorkerSupported()) {
       window.addEventListener('load', function() {
           installServiceWorker()
       });
   } else {
       console.log("Service workers are not supported.");
   }
```

--------------------------------

### Miscellaneous Methods

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

Utility methods for debugging, getting the GeoGebra version, and removing the applet.

```APIDOC
## Miscellaneous Methods

### `debug(string)`

#### Description
Prints the string to the Java Console.

#### Method
`void debug(String string)`

#### Parameters
- **string** (String) - Required - The string to print.

### `getVersion()`

#### Description
Returns the version of GeoGebra.

#### Method
`String getVersion()`

### `remove()`

#### Description
Removes the applet and frees up memory.

#### Method
`void remove()`

```

--------------------------------

### Editor State Management

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

APIs for getting and setting the state of the equation editor.

```APIDOC
## GET /websites/geogebra_github_io_reference_en/getEditorState

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

### Method
GET

### Endpoint
/websites/geogebra_github_io_reference_en/getEditorState

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **content** (String) - The content of the editor.
- **caret** (Object, optional) - Caret position information for graphing apps.
- **eval** (Object, optional) - Evaluation details for evaluator apps.
- **latex** (Object, optional) - LaTeX representation for evaluator apps.

#### Response Example
```json
{
  "content": "y = 2x + 1",
  "caret": {"pos": 5}
}
```
```

```APIDOC
## POST /websites/geogebra_github_io_reference_en/setEditorState

### Description
Sets the state of the equation editor in the algebra view or evaluator applet. The argument should be a JSON object or string containing 'content' and an optional 'caret' field.

### Method
POST

### Endpoint
/websites/geogebra_github_io_reference_en/setEditorState

### Parameters
#### Path Parameters
None

#### Query Parameters
- **state** (Object or String) - Required - A JSON object or string representing the editor state, including 'content' and optionally 'caret'.

### Request Example
```json
{
  "state": {
    "content": "x^2 + y^2 = 9",
    "caret": {"pos": 10}
  }
}
```

### Response
#### Success Response (200)
Void (operation successful)

#### Response Example
None
```

--------------------------------

### Self-Host GeoGebra: Deploy Script Path

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_Embedding

This code snippet demonstrates how to configure the embed script path for a self-hosted GeoGebra app. It modifies the default script source to point to a local deployment of the deployggb.js file.

```html
<script src="GeoGebra/deployggb.js"></script>
```

--------------------------------

### Self-Host GeoGebra: Specific Version Codebase

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_Embedding

This JavaScript snippet shows how to set the HTML5 codebase for a specific version of GeoGebra when self-hosting. It allows you to pin the applet to a particular version by providing the version number in the URL.

```javascript
applet.setHTML5Codebase("https://www.geogebra.org/apps/5.0.498.0/web3d");
```

--------------------------------

### Get Labels of Created Objects from Command (JavaScript)

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

Executes a command string in GeoGebra and returns a comma-separated string of the labels of the objects created by that command. This is an extension of the `evalCommand` functionality.

```javascript
/**
 * Evaluates a command string and returns the labels of created objects.
 * @param {string} cmdString The command string to evaluate.
 * @returns {string} A comma-separated string of labels of the created objects (e.g., "A,B,C").
 */
String evalCommandGetLabels(String cmdString);
```

--------------------------------

### Self-Host GeoGebra: Version 5.2 Codebase

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_Embedding

This JavaScript code configures the HTML5 codebase for GeoGebra version 5.2 and later when self-hosting. It specifies the correct path structure required for these versions.

```javascript
applet.setHTML5Codebase("https://www.geogebra.org/apps/5.2.804.0/web3d");
```

--------------------------------

### Get Screenshot as Base64 (Internal Use)

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

Captures the entire GeoGebra applet as a PNG screenshot and sends it to a callback function as a base64 encoded string. Available since version 5.0. **Note:** This is for internal use and may not function in all browsers.

```javascript
void getScreenshotBase64(function callback)
ggbApplet.getScreenshotBase64(function(url){window.open("data:image/png;base64,"+url);});
```

--------------------------------

### Get and Set GeoGebra Construction as JSON

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

Handles the current GeoGebra construction as a JSON object. `getFileJSON()` retrieves the construction including XML and images. `setFileJSON(Object content)` sets the construction from a provided JSON object or string.

```java
String getFileJSON()
String setFileJSON(Object content)
```

--------------------------------

### Get PNG Image as Base64 String

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

Returns the current Graphics View as a base64-encoded PNG string. Allows specifying export scale, transparency, and DPI. Introduced in version 4.0. Note: DPI setting can be slow.

```javascript
String getPNGBase64(double exportScale, boolean transparent, double DPI)
var str = ggbApplet.getPNGBase64(1, true, 72);
```

--------------------------------

### Embed GeoGebra App: JavaScript Initialization

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_Embedding

This JavaScript code initializes and injects a GeoGebra applet into a specified HTML element. It defines parameters for the app (like appName, dimensions, and UI visibility) and uses an event listener to ensure the applet is injected after the page loads.

```javascript
var params = {"appName": "graphing", "width": 800, "height": 600, "showToolBar": true, "showAlgebraInput": true, "showMenuBar": true };
var applet = new GGBApplet(params, true);
window.addEventListener("load", function() {
    applet.inject('ggb-element');
});
```

--------------------------------

### Get GeoGebra Construction as XML

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

Retrieves the current GeoGebra construction in XML format. `getXML()` returns the entire construction, while `getXML(String objName)` returns the XML for a specific object. `getAlgorithmXML(String objName)` returns the XML for a dependent object's algorithm.

```java
String getXML()
String getXML(String objName)
String getAlgorithmXML(String objName)
```

--------------------------------

### Embed GeoGebra App: Basic HTML Structure

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_Embedding

This snippet outlines the essential HTML elements required to embed a GeoGebra app. It includes meta tags for viewport and character encoding, a script tag to load the GeoGebra JavaScript library, and a div element to serve as the container for the applet.

```html
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta charset="utf-8"/>
<script src="https://www.geogebra.org/apps/deployggb.js"></script>
<div id="ggb-element"></div>
```

--------------------------------

### Get GeoGebra Construction as Base64

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

Provides the current GeoGebra construction as a base64-encoded string, typically for .ggb files. `getBase64()` returns the encoded string directly. `getBase64(function callback)` retrieves it asynchronously and passes the result to a callback function.

```java
String getBase64()
String getBase64(function callback)
```

--------------------------------

### Enable Preview Image and Play Button

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_App_Parameters

Renders a preview image and a play button instead of the applet initially. Clicking the play button initializes the applet. Defaults to false.

```json
{
  "playButton": true
}
```

```json
{
  "playButton": false
}
```

--------------------------------

### Control Welcome Tooltip Display

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_App_Parameters

Determines whether the initial 'Welcome' tooltip is shown to the user when the applet loads.

```json
{
  "showStartTooltip": true
}
```

```json
{
  "showStartTooltip": false
}
```

--------------------------------

### Enable File and User Management Features

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_App_Parameters

Determines whether file saving, loading, sign-in, and settings options are available. Ignored if the menubar is hidden.

```json
{
  "enableFileFeatures": true
}
```

```json
{
  "enableFileFeatures": false
}
```

--------------------------------

### Applet Configuration Parameters

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_App_Parameters

This section lists and describes the various parameters used to configure the GeoGebra applet's behavior and appearance.

```APIDOC
## Applet Configuration Parameters

This document details the configuration options available for GeoGebra applets, covering aspects like UI elements, behavior, and advanced settings.

### allowStyleBar

*   **Description**: Determines whether the Style Bar can be shown (or will be shown if just Graphics View 1 is showing).
*   **Type**: `boolean`
*   **Default**: `false`
*   **Version**: 4.0

### randomize

*   **Description**: Determines whether random numbers should be randomized on file load. Useful when you want the app to reload in exactly the same state it was saved.
*   **Type**: `boolean`
*   **Default**: `true`
*   **Version**: 6.0

### randomSeed

*   **Description**: Specify seed for random numbers. Note that if you save a state of the app after user interacted with it and try to reload that state with the same randomSeed, you may get a different result. Use `randomize` for those use-cases.
*   **Type**: `string` (e.g., `"randomSeed":33`)
*   **Version**: 5.0

### appletOnLoad

*   **Description**: JavaScript method to run when the activity is initialized (and file loaded if applicable).
*   **Type**: `function` (e.g., `function(api){ api.evalCommand('Segment((1,2),(3,4))'); }`)
*   **Version**: 5.0

### useBrowserForJS

*   **Description**: When true, GeoGebra runs ggbOnInit from HTML, ignores ggbOnInit from file and ignores JS update scripts of objects in file. When false, GeoGebra ignores ggbOnInit from HTML (use appletOnLoad parameter of GGBApplet instead), runs ggbOnInit from file, and runs JS update scripts of objects in file.
*   **Type**: `boolean`
*   **Default**: `false`
*   **Version**: 4.0

### showLogging

*   **Description**: Determines whether logging is shown in the Browser’s console.
*   **Type**: `boolean`
*   **Default**: `false`
*   **Version**: 4.2

### capturingThreshold

*   **Description**: Determines the sensitivity of object selection. The default value of 3 is usually fine to select and drag objects both with the mouse and touch. Use larger values (e.g. 4 or 5) to make it easier to select and drag objects.
*   **Type**: `integer`
*   **Default**: `3`
*   **Version**: 4.4

### enableFileFeatures

*   **Description**: Determines whether file saving, file loading, sign in and Options > Save settings are enabled. This argument is ignored when menubar is not showing.
*   **Type**: `boolean`
*   **Default**: `true`
*   **Version**: 5.0

### enableUndoRedo

*   **Description**: Determines whether Undo and Redo icons are shown. This argument is ignored when toolbar is not showing.
*   **Type**: `boolean`
*   **Default**: `true`
*   **Version**: 6.0

### perspective

*   **Description**: For values see SetPerspective_Command. Just for a blank start ie shouldn’t be used with _material_id_, _filename_ or _ggbBase64_ parameters.
*   **Type**: `string`
*   **Version**: 5.0

### enable3d

*   **Description**: Whether 3D should be enabled (for exam mode). When neither true nor false are entered, user can decide in a dialog.
*   **Type**: `boolean` or `none`
*   **Version**: 5.0

### enableCAS

*   **Description**: Whether CAS should be enabled (for exam mode). When neither true nor false are entered, user can decide in a dialog.
*   **Type**: `boolean` or `none`
*   **Version**: 5.0

### algebraInputPosition

*   **Description**: Determines whether input bar should be shown in algebra, on top of the applet or under the applet. When left empty (default), the position depends on file.
*   **Type**: `string` (`algebra`, `top`, or `bottom`)
*   **Version**: 5.0

### preventFocus

*   **Description**: When set to true, this prevents the applet from getting focus automatically at the start.
*   **Type**: `boolean`
*   **Default**: `false`
*   **Version**: 5.0

### scaleContainerClass

*   **Description**: Name of CSS class that is used as container; applet will scale to fit into the container.
*   **Type**: `string`
*   **Version**: 5.0

### autoHeight

*   **Description**: `true` to restrict the width of the applet and compute height automatically. `false` if you want the applet to be restricted by both width and height of the container.
*   **Type**: `boolean`
*   **Version**: 5.0

### allowUpscale

*   **Description**: Determines whether automatic scaling may scale the applet up.
*   **Type**: `boolean`
*   **Default**: `false`
*   **Version**: 5.0

### playButton

*   **Description**: Determines whether a preview image and a play button should be rendered in place of the applet. Pushing the play button initializes the applet.
*   **Type**: `boolean`
*   **Default**: `false`
*   **Version**: 5.0

### scale

*   **Description**: Ratio by which the applet should be scaled (eg. 2 makes the applet 2 times bigger, including all texts and UI elements).
*   **Type**: `number`
*   **Default**: `1`
*   **Version**: 5.0

### showAnimationButton

*   **Description**: Whether animation button should be visible.
*   **Type**: `boolean`
*   **Version**: 5.0

### showFullscreenButton

*   **Description**: Whether fullscreen button should be visible.
*   **Type**: `boolean`
*   **Version**: 6.0

### showSuggestionButtons

*   **Description**: Whether suggestion buttons (special points, solve) in Algebra View should be visible.
*   **Type**: `boolean`
*   **Version**: 6.0

### showStartTooltip

*   **Description**: Whether "Welcome" tooltip should be shown.
*   **Type**: `boolean`
*   **Version**: 5.0

### rounding

*   **Description**: String composed of number of decimal places and flags — valid flags are "s" for significant digits and "r" for rational numbers. Hence "10" means 10 decimal places, "10s" stands for 10 significant digits.
*   **Type**: `string`
*   **Version**: 6.0

### buttonShadows

*   **Description**: Whether buttons should have shadow.
*   **Type**: `boolean`
*   **Version**: 6.0

### buttonRounding

*   **Description**: Relative radius of button’s rounded border. The border radius in pixels is `buttonRounding * height /2`, where `height` is the height of the button. Default 0.2.
*   **Type**: `number` (0 - 0.9)
*   **Version**: 6.0

### buttonBorderColor

*   **Description**: Border color of buttons on the graphics view. Default is black, if the button background is white, otherwise one shade darker than the background color.
*   **Type**: `Hex color` (`#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`)
*   **Version**: 6.0

### editorBackgroundColor

*   **Description**: Background color of the evaluator app.
*   **Type**: `Hex color`
*   **Version**: 6.0
```

--------------------------------

### Show GeoGebra Help Message (Java)

Source: https://geogebra.github.io/docs/reference/en/Command_Line_Arguments

This command launches GeoGebra and displays the help message, providing information about available command-line options. It's a simple execution of the GeoGebra JAR file with the `--help` argument.

```shell
.\jre\bin\java -jar geogebra.jar --help
```

--------------------------------

### Run GeoGebra JAR with Memory Allocation (Java)

Source: https://geogebra.github.io/docs/reference/en/Command_Line_Arguments

This command executes the GeoGebra JAR file, allocating specific amounts of memory for its runtime. It's recommended to run JAR files directly with sufficient memory rather than double-clicking. The `-Xms` and `-Xmx` flags control the initial and maximum heap size, respectively. The `-Dsun.jnu.encoding=UTF-8` flag ensures proper character encoding.

```shell
.\jre\bin\java -Xms32m -Xmx1024m -Dsun.jnu.encoding=UTF-8 -jar geogebra.jar [OPTIONS] [FILES]
```

--------------------------------

### Enable Browser Console Logging

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_App_Parameters

Controls the display of logging information within the browser's developer console. Defaults to false.

```json
{
  "showLogging": true
}
```

```json
{
  "showLogging": false
}
```

--------------------------------

### Self-Host GeoGebra: Set HTML5 Codebase

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_Embedding

This JavaScript code is used for self-hosting GeoGebra apps, specifying the local path to the HTML5 codebase. This ensures the applet loads correctly from your own server.

```javascript
applet.setHTML5Codebase('GeoGebra/HTML5/5.0/web3d/');
```

--------------------------------

### Configure Style Bar Visibility

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_App_Parameters

Controls whether the Style Bar is displayed within the GeoGebra applet. Defaults to false.

```json
{
  "allowStyleBar": true
}
```

```json
{
  "allowStyleBar": false
}
```

--------------------------------

### Get Perspective XML (JavaScript)

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

Retrieves an XML string representing the current state and layout of the GeoGebra perspective (including views, toolbars, etc.). This functionality is available from version 5.0 onwards.

```javascript
const perspectiveXML = ggbApplet.getPerspectiveXML();
```

--------------------------------

### Execute JavaScript on Applet Load

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_App_Parameters

Specifies a JavaScript function to run when the GeoGebra activity is initialized. This allows for dynamic manipulation of the applet.

```javascript
{
  "appletOnLoad": "function(api){ api.evalCommand('Segment((1,2),(3,4))'); }"
}
```

--------------------------------

### Set Applet Perspective

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_App_Parameters

Configures the initial perspective or layout of the GeoGebra applet. Refer to SetPerspective_Command for valid values. Not to be used with material_id, filename, or ggbBase64 parameters.

```json
{
  "perspective": "G2D"
}
```

```json
{
  "perspective": "3D"
}
```

--------------------------------

### Get Grid Visibility (JavaScript)

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

Checks whether the coordinate grid is currently visible in a specified graphics window. If no view number is provided, it defaults to the first graphics view. Available since version 5.0.

```javascript
const isGridVisible = ggbApplet.getGridVisible(1);
```

--------------------------------

### Get Mouse Mode (JavaScript)

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

Retrieves the current mouse mode (active tool) of the GeoGebra graphics window. This functionality is available from version 5.0 onwards. Refer to the toolbar reference for detailed mode information.

```javascript
const currentMode = ggbApplet.getMode();
```

--------------------------------

### Allow Applet Upscaling

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_App_Parameters

Determines whether the GeoGebra applet is allowed to scale up beyond its original size. Defaults to false.

```json
{
  "allowUpscale": true
}
```

```json
{
  "allowUpscale": false
}
```

--------------------------------

### View and Size Management

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

APIs for setting the applet's perspective, dimensions, and recalculating environments.

```APIDOC
## POST /websites/geogebra_github_io_reference_en/setPerspective

### Description
Changes the open views within the applet. The interpretation of the perspective string is detailed in the 'SetPerspective Command' documentation.

### Method
POST

### Endpoint
/websites/geogebra_github_io_reference_en/setPerspective

### Parameters
#### Path Parameters
None

#### Query Parameters
- **perspective** (string) - Required - A string defining the desired perspective (e.g., 'G2D', '3D', 'CAS').

### Request Example
```json
{
  "perspective": "G2D"
}
```

### Response
#### Success Response (200)
Void (operation successful)

#### Response Example
None
```

```APIDOC
## POST /websites/geogebra_github_io_reference_en/setWidth

### Description
Changes the width of the applet in pixels.

### Method
POST

### Endpoint
/websites/geogebra_github_io_reference_en/setWidth

### Parameters
#### Path Parameters
None

#### Query Parameters
- **width** (int) - Required - The desired width of the applet in pixels.

### Request Example
```json
{
  "width": 800
}
```

### Response
#### Success Response (200)
Void (operation successful)

#### Response Example
None
```

```APIDOC
## POST /websites/geogebra_github_io_reference_en/setHeight

### Description
Changes the height of the applet in pixels.

### Method
POST

### Endpoint
/websites/geogebra_github_io_reference_en/setHeight

### Parameters
#### Path Parameters
None

#### Query Parameters
- **height** (int) - Required - The desired height of the applet in pixels.

### Request Example
```json
{
  "height": 600
}
```

### Response
#### Success Response (200)
Void (operation successful)

#### Response Example
None
```

```APIDOC
## POST /websites/geogebra_github_io_reference_en/setSize

### Description
Changes the width and height of the applet in pixels.

### Method
POST

### Endpoint
/websites/geogebra_github_io_reference_en/setSize

### Parameters
#### Path Parameters
None

#### Query Parameters
- **width** (int) - Required - The desired width of the applet in pixels.
- **height** (int) - Required - The desired height of the applet in pixels.

### Request Example
```json
{
  "width": 800,
  "height": 600
}
```

### Response
#### Success Response (200)
Void (operation successful)

#### Response Example
None
```

```APIDOC
## POST /websites/geogebra_github_io_reference_en/recalculateEnvironments

### Description
Updates the applet after scaling by external CSS.

### Method
POST

### Endpoint
/websites/geogebra_github_io_reference_en/recalculateEnvironments

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
Void (operation successful)

#### Response Example
None
```

--------------------------------

### Set Applet Scaling Ratio

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_App_Parameters

Specifies a scaling factor for the entire applet, including UI elements and text. A value of 2 doubles the size. Defaults to 1.

```json
{
  "scale": 1.5
}
```

```json
{
  "scale": 1
}
```

--------------------------------

### Obtaining the API Object

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

Instructions on how to obtain the GeoGebra API object, both via the `deployggb.js` script and as an ES6 module.

```APIDOC
## Obtaining the API Object

### Via `deployggb.js`

If you are loading GeoGebra using the `deployggb.js` script, you can access the api as an argument of `appletOnLoad`:

```javascript
const ggb = new GGBApplet({
  appletOnLoad(ggbApi) {
    // ggbApi provides the applet API
  }
});
ggb.inject(document.body);
```

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 cases, you should either avoid using global variables or set the `id` parameter explicitly for all apps.

### As an ES6 Module

You can use the `math-apps` module to inject the applet the ES6 way:

```html
<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:

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

```

--------------------------------

### Customize GeoGebra Notes Appearance with CSS Variables

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_Embedding

This CSS snippet demonstrates how to customize the appearance of GeoGebra Notes by setting specific CSS variables. These variables control the colors of various UI elements within the embedded app.

```css
body {
  --ggb-primary-color: #ee0290; /* used for most UI elements, including the toolbar header and buttons */
  --ggb-primary-variant-color: #880061; /* used for floating buttons on hover */
  --ggb-dark-color: #880061; /* used for highlighted text in dialogs */
  --ggb-light-color: #f186c0; /* used for progress bar */
}
```

--------------------------------

### Control Undo/Redo Functionality

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_App_Parameters

Determines the visibility of Undo and Redo icons in the toolbar. Ignored if the toolbar is not displayed.

```json
{
  "enableUndoRedo": true
}
```

```json
{
  "enableUndoRedo": false
}
```

--------------------------------

### Control Suggestion Buttons in Algebra View

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_App_Parameters

Determines whether suggestion buttons (e.g., for special points, solve) are visible in the Algebra View.

```json
{
  "showSuggestionButtons": true
}
```

```json
{
  "showSuggestionButtons": false
}
```

--------------------------------

### Obtain GeoGebra API Object as an ES6 Module

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

Shows how to inject a GeoGebra applet using the ES6 module syntax with `math-apps`. The `create` method is used to configure and inject the applet, and `getAPI()` retrieves the API object.

```javascript
<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>
```

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

--------------------------------

### Control Automatic Animation

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

Manages the automatic animation of objects within the GeoGebra Graphics View. Allows setting animation status, speed, starting, stopping, and checking if animation is currently running. Requires objects to have the 'animating' flag set.

```javascript
void setAnimating(String objName, boolean animate)
void setAnimationSpeed(String objName, double speed)
void startAnimation()
void stopAnimation()
boolean isAnimationRunning()
```

--------------------------------

### Export Graphics View to PNG

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

Exports the active Graphics View to a .PNG file. Supports custom scale, transparency, and DPI settings. DPI can be set to undefined for faster exports if not needed. Example usage demonstrates exporting with specific parameters.

```javascript
boolean writePNGtoFile(String filename, double exportScale, boolean transparent, double DPI)
// Example:
var success = ggbApplet.writePNGtoFile("myImage.png", 1, false, 72);
```

--------------------------------

### GeoGebra App Embedding Parameters

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_App_Parameters

This section details the various parameters available for configuring GeoGebra applets when embedding them.

```APIDOC
## GeoGebra App Embedding Parameters

### Description
This section details the various parameters available for configuring GeoGebra applets when embedding them into web pages.

### Method
GET (Implicit, as these are configuration parameters for an embedded applet)

### Endpoint
N/A (These are parameters used within an embedding script or tag)

### Parameters
#### Query Parameters (or attributes in an embed tag)

- **appName** (string) - Optional - The name of the GeoGebra app to load. Defaults to "classic". Examples: "graphing", "geometry", "3d", "classic", "suite", "evaluator", "scientific", "notes".
- **width** (number) - Compulsory (unless using `scaleContainerClass`) - The width of the applet.
- **height** (number) - Compulsory (unless using `scaleContainerClass`) - The height of the applet.
- **material_id** (string) - Optional - The GeoGebra Materials ID of the material to load.
- **filename** (string) - Optional - The URL of the .ggb file to load.
- **ggbBase64** (string) - Optional - A base64 encoded .ggb file to load.
- **borderColor** (string) - Optional - The color of the border line around the applet panel (hex rgb string). Default: gray.
- **borderRadius** (number) - Optional - The size of the applet's border radius in pixels.
- **enableRightClick** (boolean) - Optional - Enables or disables right-click context menus and other related features. Default: true.
- **enableLabelDrags** (boolean) - Optional - Enables or disables dragging of labels. Default: true.
- **enableShiftDragZoom** (boolean) - Optional - Enables or disables moving and zooming of the drawing pad using Shift or Ctrl keys. Default: true.
- **showZoomButtons** (boolean) - Optional - Shows or hides the zoom in/out/home buttons. Default: false.
- **errorDialogsActive** (boolean) - Optional - Shows or hides error dialogs for invalid input. Default: true.
- **showMenuBar** (boolean) - Optional - Shows or hides the GeoGebra menu bar. Default: false.
- **showToolBar** (boolean) - Optional - Shows or hides the toolbar. Default: false.
- **showToolBarHelp** (boolean) - Optional - Shows or hides the toolbar help text. Default: false.
- **customToolBar** (string) - Optional - Sets a custom toolbar string to override the saved toolbar.
- **customToolbox** (string) - Optional - Sets the Notes toolbox content using tool names or categories.
- **showAlgebraInput** (boolean) - Optional - Shows or hides the algebra input line. Default: false.
- **showResetIcon** (boolean) - Optional - Shows or hides the reset icon in the upper right corner. Default: false.
- **language** (string) - Optional - The ISO language string to set the applet's language. GeoGebra attempts to auto-detect the user's local language.
- **country** (string) - Optional - The ISO country string, used in conjunction with the `language` parameter.
- **id** (string) - Optional - Specifies the argument passed to the `ggbOnInit()` JavaScript function, useful for multiple applets on a page.

### Request Example
```html
<script src="https://cdn.geogebra.org/apps/deployggb.js"></script>
<script>
  var ggbApplet = new GGBApplet({
    "appName": "graphing",
    "width": 800,
    "height": 600,
    "material_id": "RHYH3UQ8",
    "borderColor": "#000000",
    "enableRightClick": false
  }, "5.0", "true");
  ggbApplet.inject('ggbApplet');
</script>
<div id="ggbApplet"></div>
```

### Response
#### Success Response (Implicit)
GeoGebra applet renders with the specified configurations.

#### Response Example
N/A (This is a client-side rendering configuration)
```

--------------------------------

### Control Button Shadow Appearance

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_App_Parameters

Determines whether buttons within the GeoGebra applet should display shadows. Defaults to false.

```json
{
  "buttonShadows": true
}
```

```json
{
  "buttonShadows": false
}
```

--------------------------------

### Control Fullscreen Button Visibility

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_App_Parameters

Determines whether the fullscreen button is visible within the GeoGebra applet.

```json
{
  "showFullscreenButton": true
}
```

```json
{
  "showFullscreenButton": false
}
```

--------------------------------

### Client Events

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

This section lists various client-side events that can be observed. Each event has a type, potential attributes, and a description of when it occurs.

```APIDOC
## Client Events API

### Description
Observe client-side events using the `registerClientListener` method. This API details the available event types, their associated attributes, and a description of their functionality.

### Method
`registerClientListener` (Implicit - Event Observation)

### Endpoint
N/A (Client-side event listener registration)

### Parameters
#### Event Types
- **addMacro** (Type: Event) - Description: When a new macro is added. Attributes: `argument` (macro name).
- **addPolygon** (Type: Event) - Description: Polygon construction started.
- **addPolygonComplete** (Type: Event) - Description: Polygon construction finished. Attributes: `target` (polygon label).
- **algebraPanelSelected** (Type: Event) - Description: Algebra tab selected in the sidebar (Graphing / Geometry apps).
- **deleteGeos** (Type: Event) - Description: Multiple objects deleted.
- **deselect** (Type: Event) - Description: One or all objects removed from selection. Attributes: `target` (object name or null for deselect all).
- **dragEnd** (Type: Event) - Description: Mouse drag ended.
- **dropdownClosed** (Type: Event) - Description: Dropdown list closed. Attributes: `target` (dropdown list name), `index` (index of selected item).
- **dropdownItemFocused** (Type: Event) - Description: Dropdown list item focused. Attributes: `target` (dropdown list name), `index` (index of focused item).
- **dropdownOpened** (Type: Event) - Description: Dropdown list opened. Attributes: `target` (dropdown list name).
- **editorKeyTyped** (Type: Event) - Description: Key typed in the editor (Algebra view or Evaluator app).
- **editorStart** (Type: Event) - Description: User moves focus to the editor. Attributes: `target` (object label if editing existing object).
- **editorStop** (Type: Event) - Description: User moves focus away from the editor. Attributes: `target` (object label if editing existing object).
- **export** (Type: Event) - Description: Export started. Attributes: `argument` (JSON encoded array including export format).
- **mouseDown** (Type: Event) - Description: User pressed the mouse button. Attributes: `x` (mouse x-coordinate), `y` (mouse y-coordinate).
- **movedGeos** (Type: Event) - Description: Multiple objects move ended. Attributes: `argument` (object labels).
- **movingGeos** (Type: Event) - Description: Multiple objects are being moved. Attributes: `argument` (object labels).
- **openDialog** (Type: Event) - Description: Dialog is opened. Attributes: `argument` (dialog ID).
- **openMenu** (Type: Event) - Description: Main menu or one of its submenus were open. Attributes: `argument` (submenu ID).
- **pasteElms** (Type: Event) - Description: Pasting multiple objects started. Attributes: `argument` (pasted objects as XML).
- **pasteElmsComplete** (Type: Event) - Description: Pasting multiple objects ended.
- **perspectiveChange** (Type: Event) - Description: Perspective changed (e.g., a view was opened or closed).
- **redo** (Type: Event) - Description: Redo button pressed.
- **relationTool** (Type: Event) - Description: Relation tool used. Attributes: `argument` (HTML description of the object relation).
- **removeMacro** (Type: Event) - Description: Custom tool removed. Attributes: `argument` (custom tool name).
- **renameComplete** (Type: Event) - Description: Object renaming complete (for chain renames).
- **renameMacro** (Type: Event) - Description: Custom tool was renamed. Attributes: `argument` (array [old name, new name]).
- **select** (Type: Event) - Description: Object added to selection. Attributes: `target` (object label).
- **setMode** (Type: Event) - Description: App mode changed (e.g., a tool was selected). Attributes: `argument` (mode number).
- **showNavigationBar** (Type: Event) - Description: Navigation bar visibility changed. Attributes: `argument` ("true" or "false").
- **showStyleBar** (Type: Event) - Description: Style bar visibility changed. Attributes: `argument` ("true" or "false").
- **sidePanelClosed** (Type: Event) - Description: Side panel closed (e.g., algebra view in Graphing Calculator).
- **sidePanelOpened** (Type: Event) - Description: Side panel opened (e.g., algebra view in Graphing Calculator).
- **tablePanelSelected** (Type: Event) - Description: Table of values panel selected.
- **toolsPanelSelected** (Type: Event) - Description: Tools panel selected.
- **undo** (Type: Event) - Description: Undo button pressed.
- **updateStyle** (Type: Event) - Description: Object style changed. Attributes: `target` (object label).
- **viewChanged2D** (Type: Event) - Description: 2D graphics view dimensions changed by zooming or panning. Attributes: `xZero`, `yZero`, `xscale`, `yscale`, `viewNo`.
- **viewChanged3D** (Type: Event) - Description: 3D graphics view dimensions changed by zooming or panning. Attributes: `xZero`, `yZero`, `scale`, `yscale`, `viewNo`, `zZero`, `zscale`, `xAngle`, `zAngle`.

### Request Example
```json
{
  "eventName": "addPolygonComplete",
  "data": {
    "target": "myPolygon"
  }
}
```

### Response
(Responses are event-specific and handled by the listener callback function)

#### Success Response (Event Triggered)
- **eventName** (string) - The name of the event that was triggered.
- **data** (object) - An object containing event-specific attributes.

#### Response Example
```json
{
  "eventName": "addPolygonComplete",
  "data": {
    "target": "myPolygon"
  }
}
```
```

--------------------------------

### Automatic Applet Height Calculation

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_App_Parameters

When set to true, the applet's width is restricted, and its height is automatically computed to fit its content. Defaults to false.

```json
{
  "autoHeight": true
}
```

```json
{
  "autoHeight": false
}
```

--------------------------------

### Open Construction File (Java/JavaScript)

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

Opens a GeoGebra construction from a specified file URL. This method was introduced in version 2.7 and is noted as 'Java only' in some contexts, but is generally available via the JavaScript API for web applets. The URL can be absolute or relative.

```javascript
ggbApplet.openFile("path/to/your/construction.ggb");
```

--------------------------------

### Obtain GeoGebra API Object with deployggb.js

Source: https://geogebra.github.io/docs/reference/en/GeoGebra_Apps_API

Demonstrates how to access the GeoGebra API when using the `deployggb.js` script. The API object is provided as an argument to the `appletOnLoad` callback function.

```javascript
const ggb = new GGBApplet({
  appletOnLoad(ggbApi) {
    // ggbApi provides the applet API
  }
});
ggb.inject(document.body);
```
Tokens:
Raw