Reference:Applet Parameters

From GeoGebra Manual
Jump to: navigation, search

GeoGebra API Documentation

Please have a look at Reference:Applet Embedding to see how applets can be embedded into web pages and parameters can be applied. Additionally you can download a GeoGebra material as an offline worksheet (.zip). The following parameters may be used within the script tag including ' var parameters =':

Name Value Description Since
width eg 800 Applet width (compulsory field)
height eg 600 Applet height (compulsory field)
material_id eg "RHYH3UQ8" GeoGebra Materials id to load


See first applet here: https://dev.geogebra.org/examples/html/example-multiple.html

5.0
filename eg "myFile.ggb" URL of file to load


See second applet here: https://dev.geogebra.org/examples/html/example-multiple.html

4.0
ggbBase64 base64 encoded .ggb file Encoded file to load.


See the applet here: https://dev.geogebra.org/examples/html/example-single.html

4.0
borderColor e.g. #FFFFFF for white Color of the border line drawn around the applet panel (as hex rgb string). Default: gray 3.0
enableRightClick true or false States whether right clicks should be handled by the applet. Setting this parameter to "false" disables context menus, properties dialogs and right-click-zooming. Default: true. NB also enables/disables some keyboard shortcuts eg Delete and Ctrl + R (recompute all objects). Default: true 3.0
enableLabelDrags true or false States whether labels can be dragged. Default: true 3.2
enableShiftDragZoom true or false States whether the drawing pad should be moveable using Shift + mouse drag (or. Ctrl + mouse drag) or zoomable using Shift + mouse wheel (or Ctrl + mouse wheel). Setting this parameter to "false" disables moving and zooming of the drawing pad. Default: true 3.0
errorDialogsActive true or false States whether error dialogs will be shown if an invalid input is entered (using the Input Bar or JavaScript) Default: true 3.2
showMenuBar true or false States whether the menubar of GeoGebra should be shown in the applet. Default: false 2.5
showToolBar true or false States whether the toolbar with the construction mode buttons should be shown in the applet. Default: false 2.5
showToolBarHelp true or false States whether the toolbar help text right to the toolbar buttons should be shown in the applet 3.0
customToolBar e.g. 0 1 2 3 , 4 5 6 7 Sets the toolbar according to a custom toolbar string where the int values are Toolbar Mode Values, , adds a separator within a menu, | starts a new menu and || adds a separator in the toolbar before starting a new menu. Custom tools are numbered 1001, 1002, etc in GeoGebra 3.2 and 100 001, 100 002, etc from GeoGebra 4. 2.5
showAlgebraInput true or false States whether the algebra input line (with input field, greek letters and command list) should be shown in the applet. Default: false 2.5
showResetIcon true or false States whether a small icon (GeoGebra ellipse) should be shown in the upper right corner of the applet. Clicking on this icon resets the applet (i.e. it reloads the file given in the filename parameter). Default: false 2.5
language iso language string
en ... English
fr ... French
it ... Italian
de ... German
es ... Spanish
nb ... Norwegian / Bokmål
nn ... Norwegian / Nynorsk
pt ... Portuguese
zh ... Chinese (also needs CN or TW as country code)
GeoGebra tries to set your local language automatically (if it is available among the supported languages, of course). The default language for unsupported languages is English. If you want to specify a certain language manually, please use this parameter. 2.5
country iso country string, e.g. AT for Austria This parameter only makes sense if you use it together with the language parameter. 2.5
ggbOnInitParam/data-param-id eg applet2 This parameter allows you to specify the argument passed to the JavaScript function ggbOnInit(), which is called once the applet is fully initialised. This is useful when you have multiple applets on a page - see this example (will have no effect in earlier versions) 3.2
allowStyleBar true or false Default: false
Determines whether the Style Bar can be shown (or will be shown if just Graphics View 1 is showing)
4.0
useBrowserForJS true or false When true, GeoGebra
  • runs ggbOnInit from HTML
  • ignores ggbOnInit from file
  • 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
  • runs JS update scripts of objects in file
4.0
showLogging true or false Default: false
Determines whether logging is shown in the Browser's console
4.2
capturingThreshold integer Default: 3
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.
4.4
enableFileFeatures true or false Default: true
Determines whether file saving, file loading, sign in and Options > Save settings are enabled. This argument is ignored when menubar is not showing.
5.0
perspective string For values see SetPerspective_Command 5.0
enable3d true or false or none Whether 3D should be enabled (for exam mode). When neither true nor false are entered, user can decide in a dialog. 5.0
enableCAS true or false or none Whether CAS should be enabled (for exam mode). When neither true nor false are entered, user can decide in a dialog. 5.0
algebraInputPosition algebra, top or bottom Default: empty
Determines whether input bar should be shown in algebra, on top of the applet or under the applet. When left empty, the position depends on file.
5.0
preventFocus true or false Default: false. When set to true, this prevents the applet from getting focus automatically at the start. 5.0
scaleContainerClass String Name of CSS class that is used as container; applet will scale to fit into the container. 5.0
allowUpscale true or false Default: false
Determines whether automatic scaling may scale the applet up
5.0
playButton true or false Default: false
Determines whether a preview image and a play button should be rendered in place of the applet. Pushing the play button initializes the applet.
5.0
scale number Ratio by which the applet should be scaled (eg. 2 makes the applet 2 times bigger, including all texts and UI elements). Default: 1 5.0
showAnimationButton true or false Whether animation button should be visible 5.0
showFullscreenButton true or false Whether fullscreen button should be visible 6.0
appName graphing, geometry, 3d or classic Which app should be shown (default: classic 6.0
showSuggestionButtons true or false Whether suggestion buttons (special points, solve) in Algebra View should be visible 6.0
showStartTooltip true or false Whether "Welcome" tooltip should be shown 5.0
rounding string 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. 6.0
buttonShadows true or false Whether buttons should have shaddow 6.0 (incubating)
buttonRounding Number (0 - 0.9) 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. 6.0 (incubating)

Properties marked as incubating may change in the future.

© 2017 International GeoGebra Institute