Difference between revisions of "Reference:GeoGebra App Parameters"

From GeoGebra Manual
Jump to: navigation, search
 
(77 intermediate revisions by 9 users not shown)
Line 1: Line 1:
−
To include a GeoGebra Applet into an HTML page you could use "Export dynamic worksheet as webpage" in [[File Menu]]. However, for more advanced users, it is also possible to include the applet tag by hand.
+
This page lists all parameters that can be used to configure GeoGebra Apps. Please see [[Reference:GeoGebra Apps Embedding|GeoGebra Apps Embedding]] to learn how to embed GeoGebra apps into your pages and where these parameters can be used.
−
===Applet tag===
+
 
−
You can use the following lines to include a GeoGebra construction in your html page. The construction file (e.g. "circle.ggb") have to be placed in the directory of your html page.
 
−
<pre>&lt;applet code="geogebra.GeoGebraApplet"  archive="geogebra.jar"
 
−
  codebase="http://jars.geogebra.org/webstart/"
 
−
  width="500" height="300"&gt;
 
−
      &lt;param name="filename" value="circle.ggb" /&gt;
 
−
      &lt;param name="framePossible" value="false" /&gt;
 
−
Please  install Java 1.5 (or later) from www.java.com to use this page.
 
−
&lt;/applet>
 
−
</pre>
 
−
Instead of ''filename'' parameter you may use ''ggbBase64'' paramter with your file encoded in Base64. To obtain this code, just press {{KeyCode|Ctrl+Shift+M}} -- the whole applet tag  with this code will appear in your clipboard.
 
−
===Codebase===
 
−
Codebase defines the location of GeoGebra jar files. You can set it to following values
 
−
* http://jars.geogebra.org/webstart/4.0/unsigned/ &ndash; unsigned version of GeoGebra will be used. This version does not have access to user's hardware (options like Undo, Redo, Save and Print are disabled), but user doesn't have to confirm that he is aware of security risks
 
−
* http://jars.geogebra.org/webstart/4.0 &ndash; use this if you need Undo, Redo, Save or Print options
 
−
* local path, e.g. <code>./</code> &ndash; might be useful if you want your worksheet to be accessible without connection to geogebra.org. You will need to download all jar files from one of the aforementioned URLs to the local path (in case the codebase is <code>./</code>, place the jar files in the same folder as the worksheet).
 
−
===Applet parameters===
 
−
The following parameters may be used within the applet tag.
 
 
{| class="pretty"
 
{| class="pretty"
−
!width="15%"|Name  
+
!width="15%"|Name
−
!width="15%"|GeoGebraWeb
 
 
!width="15%"|Value
 
!width="15%"|Value
 
!width="55%"|Description
 
!width="55%"|Description
 
!Since
 
!Since
 
|-
 
|-
−
|filename
+
|appName
 +
| eg <code>"graphing"</code>
 +
| app name, default: "classic"
 +
"graphing" ... GeoGebra Graphing Calculator
 +
<br/>"geometry" ... GeoGebra Geometry
 +
<br/>"3d" ... GeoGebra 3D Graphing Calculator
 +
<br/>"classic" ... GeoGebra Classic
 +
<br/>"suite" ... GeoGebra Calculator Suite
 +
<br/>"evaluator" ... Equation Editor
 +
<br/>"scientific" ... Scientific Calculator
 +
<br/>"notes" ... GeoGebra Notes
 +
|6.0
 +
|-
 +
|width
 +
| eg <code>800</code>
 +
|Applet width ('''compulsory field''' unless using <code>scaleContainerClass</code>)
 
|
 
|
−
|e.g. <code>file.ggb</code>
 
−
|Path to the construction file.
 
−
|2.5
 
 
|-
 
|-
−
|ggbBase64
+
|height
−
|data-param-ggbbase64
+
| eg <code>600</code>
 +
|Applet height ('''compulsory field''' unless using <code>scaleContainerClass</code>)
 
|
 
|
−
|Base64-encoded string of a .ggb file
 
−
|3.2
 
 
|-
 
|-
−
|type
+
|material_id
−
|
+
| eg <code>"RHYH3UQ8"</code>
−
|<code>button</code>
+
|GeoGebra Materials id to load
−
|If you use this parameter the applet will only show a button to open the GeoGebra application frame.<br><b>Deprecated from GeoGebra 4</b>
+
<br>See first applet here: https://dev.geogebra.org/examples/html/example-multiple.html
−
|2.5 - 3.2
+
|5.0
 
|-
 
|-
−
|framePossible
+
|filename
−
|
+
| eg <code>"myFile.ggb"</code>
−
|<code>true</code> or <code>false</code>
+
| URL of file to load
−
|States if a double click on the drawing pad should open the GeoGebra application frame. This parameter is ignored if the type was set to "button". Default: true<br><b>Deprecated from GeoGebra 4</b>
+
<br>See second applet here: https://dev.geogebra.org/examples/html/example-multiple.html
−
|2.5 - 3.2
+
|4.0
 
|-
 
|-
−
|bgcolor
+
|ggbBase64
−
|
+
|base64 encoded .ggb file
−
|e.g. <code>#FFFFFF</code> for white
+
|Encoded file to load.
−
|Background color (as hex rgb string) of the applet. This parameter is only used if type "button" was set. Default: white
+
<br>See the applet here: https://dev.geogebra.org/examples/html/example-single.html
−
|2.5
+
|4.0
 
|-
 
|-
 
|borderColor
 
|borderColor
−
|
 
 
|e.g. <code>#FFFFFF</code> for white
 
|e.g. <code>#FFFFFF</code> for white
 
|Color of the border line drawn around the applet panel&nbsp;(as hex rgb string). Default: gray
 
|Color of the border line drawn around the applet panel&nbsp;(as hex rgb string). Default: gray
 
|3.0
 
|3.0
 
|-
 
|-
−
|enableChooserPopups
+
|borderRadius
−
|
+
|number
−
|<code>true</code> or <code>false</code>
+
|Size of applet's [https://developer.mozilla.org/en-US/docs/Web/CSS/border-radius border radius] in pixels.
−
|Controls whether a popup menu is shown or not when you click on multiple objects. Default: true<br><b>Deprecated from GeoGebra 4</b>
+
|6.0
−
|3.2
 
 
|-
 
|-
 
|enableRightClick
 
|enableRightClick
−
|
 
 
|<code>true</code> or <code>false</code>
 
|<code>true</code> or <code>false</code>
−
|States whether right clicks should be handled by the applet. Setting this parameter&nbsp;to "false" disables context menus, properties dialogs and right-click-zooming. Default: true.  NB also enables/disables some keyboard shortcuts eg {{KeyCode|Delete}} and {{KeyCode|Ctrl+R}} (recompute all objects)
+
|States whether right clicks should be handled by the applet. Setting this parameter&nbsp;to "false" disables context menus, properties dialogs and right-click-zooming. Default: true.  NB also enables/disables some keyboard shortcuts eg {{KeyCode|Delete}} and {{KeyCode|Ctrl+R}} (recompute all objects). Default: true
 
|3.0
 
|3.0
 
|-
 
|-
 
|enableLabelDrags
 
|enableLabelDrags
−
|data-param-enableLabelDrags
 
 
|<code>true</code> or <code>false</code>
 
|<code>true</code> or <code>false</code>
 
|States whether labels can be dragged. Default: true
 
|States whether labels can be dragged. Default: true
 
|3.2
 
|3.2
 
|-
 
|-
−
|allowRescaling
+
|enableShiftDragZoom
−
|
 
 
|<code>true</code> or <code>false</code>
 
|<code>true</code> or <code>false</code>
−
|Determines whether the applet will attempt to rescale the Graphics View when the applet is loaded or the size is changed (eg Zooming in the browser). Disabled if the Spreadsheet or Algebra View are showing. Default: false
+
|States whether the Graphics View(s) should be moveable using Shift + mouse drag (or. Ctrl +&nbsp;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.2
+
|3.0
 
|-
 
|-
−
|enableShiftDragZoom
+
|showZoomButtons
−
|data-param-enableShiftDragZoom
 
 
|<code>true</code> or <code>false</code>
 
|<code>true</code> or <code>false</code>
−
|States whether the drawing pad should be moveable using Shift + mouse drag (or. Ctrl +&nbsp;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
+
|States whether the zoom in / zoom out / home buttons should be shown in the Graphics View or not. Default: false
−
|3.0
+
|6.0
 
|-
 
|-
 
|errorDialogsActive
 
|errorDialogsActive
−
|
 
 
|<code>true</code> or <code>false</code>
 
|<code>true</code> or <code>false</code>
 
|States whether error dialogs will be shown if an invalid input is entered (using the Input Bar or JavaScript) Default: true
 
|States whether error dialogs will be shown if an invalid input is entered (using the Input Bar or JavaScript) Default: true
Line 98: Line 84:
 
|-
 
|-
 
|showMenuBar
 
|showMenuBar
−
|data-param-showMenuBar
 
 
|<code>true</code> or <code>false</code>
 
|<code>true</code> or <code>false</code>
 
|States whether the menubar of GeoGebra should be shown in the applet. Default: false
 
|States whether the menubar of GeoGebra should be shown in the applet. Default: false
Line 104: Line 89:
 
|-
 
|-
 
|showToolBar
 
|showToolBar
−
|data-param-showToolBar
 
 
|<code>true</code> or <code>false</code>
 
|<code>true</code> or <code>false</code>
 
|States whether the toolbar with the construction mode buttons should be shown in the applet. Default: false
 
|States whether the toolbar with the construction mode buttons should be shown in the applet. Default: false
 
|2.5
 
|2.5
−
|-
 
−
|maxIconSize
 
−
|
 
−
|16 to 32
 
−
|Maximum size of icons used in the toolbar in pixels. Default: 32
 
−
|3.2
 
 
|-
 
|-
 
|showToolBarHelp
 
|showToolBarHelp
−
|
 
 
|<code>true</code> or <code>false</code>
 
|<code>true</code> or <code>false</code>
 
|States whether the toolbar help text right to the toolbar buttons should be shown in the applet
 
|States whether the toolbar help text right to the toolbar buttons should be shown in the applet
Line 122: Line 99:
 
|-
 
|-
 
|customToolBar
 
|customToolBar
−
|data-param-customToolBar
 
 
|e.g. <code>0  1 2  3 , 4  5 6 7</code>
 
|e.g. <code>0  1 2  3 , 4  5 6 7</code>
−
|Sets the toolbar according to a custom toolbar string where the int values are [[Reference:Toolbar|Toolbar Mode Values]], <code>,</code> adds a separator within a menu, <code>|</code> starts a new menu and <code><nowiki>||</nowiki></code> 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.
+
|Sets the toolbar according to a custom toolbar string where the int values are [[Reference:Toolbar|Toolbar Mode Values]], <code>,</code> adds a separator within a menu, <code>|</code> starts a new menu and <code><nowiki>||</nowiki></code> adds a separator in the toolbar before starting a new menu. This will override the saved toolbar from the .ggb file / base64 string. Custom tools are numbered 100 001, 100 002, etc
 
|2.5
 
|2.5
 
|-
 
|-
 
|showAlgebraInput
 
|showAlgebraInput
−
|data-param-showAlgebraInput
 
 
|<code>true</code> or <code>false</code>
 
|<code>true</code> or <code>false</code>
 
|States whether the algebra input line (with input field, greek letters and command list) should be shown in the applet. Default: false
 
|States whether the algebra input line (with input field, greek letters and command list) should be shown in the applet. Default: false
Line 134: Line 109:
 
|-
 
|-
 
|showResetIcon
 
|showResetIcon
−
|data-param-showResetIcon
 
 
|<code>true</code> or <code>false</code>
 
|<code>true</code> or <code>false</code>
 
|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
 
|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
Line 140: Line 114:
 
|-
 
|-
 
|language
 
|language
−
|data-param-language
 
 
|[[w:List_of_ISO_639-1_codes|iso language string]]
 
|[[w:List_of_ISO_639-1_codes|iso language string]]
−
en ... English
 
−
fr ... French
 
−
it ... Italian
 
−
de ... German
 
−
es ... Spanish
 
−
pt ... Portuguese
 
−
zh ... Chinese
 
 
|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.
 
|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
 
|2.5
 
|-
 
|-
 
|country
 
|country
−
|data-param-country
 
 
|iso country string, e.g. <code>AT</code> for Austria
 
|iso country string, e.g. <code>AT</code> for Austria
 
|This parameter only makes sense if you use it together with the language parameter.
 
|This parameter only makes sense if you use it together with the language parameter.
 
|2.5
 
|2.5
 
|-
 
|-
−
|ggbOnInitParam
+
|id
−
|data-param-ggbOnInitParam
 
 
|eg <code>applet2</code>
 
|eg <code>applet2</code>
−
|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 http://www.geogebra.org/source/program/applet/geogebra_applet_java2java.htm (will have no effect in earlier versions)
+
|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 [http://dev.geogebra.org/examples/html/example-api-sync.html this example] (will have no effect in earlier versions)
−
|3.2
 
−
|-
 
−
|java_arguments
 
−
|
 
−
|eg <code>-Xmx256m</code>
 
−
|This parameter allows you to specify more memory (in megabytes) for the GeoGebra applet. <b>Works only in Java 6 update 10 or later</b> (will have no effect in earlier versions)
 
 
|3.2
 
|3.2
 
|-
 
|-
 
|allowStyleBar
 
|allowStyleBar
−
|
 
 
|<code>true</code> or <code>false</code>
 
|<code>true</code> or <code>false</code>
−
|Default: false<br>Determines whether the Style Bar can be shown (or will be shown if just Graphics View 1 is showing)
+
|Determines whether the Style Bar can be shown (or will be shown if just Graphics View 1 is showing)<br>'''Default:''' false
 
|4.0
 
|4.0
 +
|-
 +
|randomize
 +
|<code>true</code> or <code>false</code>
 +
|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.<br>'''Default:''' true
 +
|6.0
 +
|-
 +
|randomSeed
 +
|eg <code>"randomSeed":33</code>
 +
|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 <code>randomize</code> for those use-cases.
 +
|5.0
 +
|-
 +
|appletOnLoad
 +
|eg <code>function(api){ api.evalCommand('Segment((1,2),(3,4))'); }</code>
 +
|JavaScript method to run when the activity is initialized (and file loaded if applicable)
 +
|5.0
 
|-
 
|-
 
|useBrowserForJS
 
|useBrowserForJS
−
|
 
 
|<code>true</code> or <code>false</code>
 
|<code>true</code> or <code>false</code>
−
|Default: true<br>Determines whether Rhino (built into GeoGebra) or the browser will be used to run JavaScript.
+
|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
 +
'''Default: false'''
 
|4.0
 
|4.0
 +
|-
 +
|showLogging
 +
|<code>true</code> or <code>false</code>
 +
|Determines whether logging is shown in the Browser's console<br>'''Default:''' false
 +
|4.2
 +
|-
 +
|capturingThreshold
 +
|integer
 +
|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.<br>'''Default:''' 3
 +
|4.4
 +
|-
 +
|enableFileFeatures
 +
|<code>true</code> or <code>false</code>
 +
|Determines whether file saving, file loading, sign in and Options > Save settings are enabled. This argument is ignored when menubar is not showing.<br>'''Default:''' true
 +
|5.0
 +
|-
 +
|enableUndoRedo
 +
|<code>true</code> or <code>false</code>
 +
|Determines whether Undo and Redo icons are shown. This argument is ignored when toolbar is not showing.<br>'''Default:''' true
 +
|6.0
 +
|-
 +
|perspective
 +
|string
 +
|For values see [[SetPerspective_Command]]. Just for a blank start ie shouldn't be used with ''material_id'', ''filename'' or ''ggbBase64'' parameters
 +
|5.0
 +
|-
 +
|enable3d
 +
|<code>true</code> or <code>false</code> 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
 +
|<code>true</code> or <code>false</code> 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
 +
|<code>algebra</code>, <code>top</code> or <code>bottom</code>
 +
|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.
 +
|5.0
 +
|-
 +
|preventFocus
 +
|<code>true</code> or <code>false</code>
 +
|When set to true, this prevents the applet from getting focus automatically at the start.<br>'''Default:''' false
 +
|5.0
 +
|-
 +
|scaleContainerClass
 +
|String
 +
|Name of CSS class that is used as container; applet will scale to fit into the container.
 +
|5.0
 +
|-
 +
|autoHeight
 +
|boolean
 +
|• <code>true</code> to restrict the width of the applet and compute height automatically, add <code>autoHeight:true</code><br>• <code>false</code>if you want the applet to be restricted by both width and height of the container
 +
|5.0
 +
|-
 +
|allowUpscale
 +
|<code>true</code> or <code>false</code>
 +
|Determines whether automatic scaling may scale the applet up<br>'''Default:''' false
 +
|5.0
 +
|-
 +
|playButton
 +
|<code>true</code> or <code>false</code>
 +
|Determines whether a preview image and a play button should be rendered in place of the applet. Pushing the play button initializes the applet.<br>'''Default:''' false
 +
|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). <br>'''Default:''' 1
 +
|5.0
 +
|-
 +
|showAnimationButton
 +
|<code>true</code> or <code>false</code>
 +
|Whether animation button should be visible
 +
|5.0
 +
|-
 +
|showFullscreenButton
 +
|<code>true</code> or <code>false</code>
 +
|Whether fullscreen button should be visible
 +
|6.0
 +
|-
 +
|showSuggestionButtons
 +
|<code>true</code> or <code>false</code>
 +
|Whether suggestion buttons (special points, solve) in Algebra View should be visible
 +
|6.0
 +
|-
 +
|showStartTooltip
 +
|<code>true</code> or <code>false</code>
 +
|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
 +
|<code>true</code> or <code>false</code>
 +
|Whether buttons should have shadow
 +
|6.0
 +
|-
 +
|buttonRounding
 +
|Number (0 - 0.9)
 +
|Relative radius of button's rounded border. The border radius in pixels is <code>buttonRounding * height /2</code>, where <code>height</code> is the height of the button. Default 0.2.
 +
|6.0
 +
|-
 +
|buttonBorderColor
 +
|Hex color (<code>#RGB</code>, <code>#RGBA</code>, <code>#RRGGBB</code> or <code>#RRGGBBAA</code>)
 +
|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
 +
|6.0
 +
|-
 +
|editorBackgroundColor
 +
|Hex color
 +
|Background color of the evaluator app
 +
|6.0
 +
|-
 +
|editorForegroundColor
 +
|Hex color
 +
|Foreground (text) color of the equation editor (appname = "evaluator")
 +
|6.0
 +
|-
 +
|textmode
 +
|<code>true</code> or <code>false</code>
 +
|Whether editor is in text mode or not (appname = "evaluator")<br>'''Default:''' <code>false</code>
 +
|6.0
 +
|-
 +
|showKeyboardOnFocus
 +
|<code>"false"|"true"|"auto"</code>
 +
|Whether to show keyboard when input is focused. When set to <code>true</code>, keyboard is always shown, for <code>false</code> it never appears, for <code>auto</code> it's shown unless closed by user. <br>'''Default:''' <code>true</code> in evaluator app, <code>auto</code> in other apps
 +
|6.0
 +
|-
 +
|keyboardType
 +
|<code>"scientific"|"normal"|"notes"</code>
 +
|Which keyboard is shown for equation editor (appname = "evaluator")
 +
|6.0
 +
|-
 +
|transparentGraphics
 +
|<code>true</code> or <code>false</code>
 +
|Whether the Graphics View and Graphics View 2 should be transparent
 +
|6.0
 +
|-
 +
|disableJavaScript
 +
|<code>true</code> or <code>false</code>
 +
|Whether running JavaScript from material files is disabled or not.
 +
|6.0
 +
|-
 +
|detachedKeyboardParent
 +
|String
 +
|When set, keyboard should be attached to the first element in DOM that fits the selector.
 +
|6.0
 
|}
 
|}
−
===Examples===
+
[[Category:Reference|GeoGebra Apps Parameters]]
−
{{example|1=
 
−
The following lines are an example for a "button" applet that only consists of a button to open GeoGebra's window. The background of the applet (i.e. the area around the button) is set to white (#FFFFFF).</p>
 
−
<pre>&lt;applet code="geogebra.GeoGebraApplet"
 
−
  archive="geogebra.jar"
 
−
  width=200 height=40&gt;
 
−
&lt;param name="filename" value="circle.ggb" /&gt;
 
−
&lt;param name="type" value="button" /&gt;
 
−
&lt;param name="bgcolor" value="#FFFFFF" /&gt;
 
−
Please &lt;a href="http://java.sun.com/getjava"&gt;install Java
 
−
1.4&lt;/a&gt; (or later) to use this page.
 
−
&lt;/applet&gt;</pre>}}
 
−
[[Category:Reference|Applet Parameters]]
 
−
[[es:Referencia:Parámetros Applet]]
 
−
[[it:Riferimenti:Parametri applet]]
 
−
[[fr:Référence:Paramètres Appliquette]]
 

Latest revision as of 15:31, 25 March 2024

This page lists all parameters that can be used to configure GeoGebra Apps. Please see GeoGebra Apps Embedding to learn how to embed GeoGebra apps into your pages and where these parameters can be used.

Name Value Description Since
appName eg "graphing" app name, default: "classic"

"graphing" ... GeoGebra Graphing Calculator
"geometry" ... GeoGebra Geometry
"3d" ... GeoGebra 3D Graphing Calculator
"classic" ... GeoGebra Classic
"suite" ... GeoGebra Calculator Suite
"evaluator" ... Equation Editor
"scientific" ... Scientific Calculator
"notes" ... GeoGebra Notes

6.0
width eg 800 Applet width (compulsory field unless using scaleContainerClass)
height eg 600 Applet height (compulsory field unless using scaleContainerClass)
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
borderRadius number Size of applet's border radius in pixels. 6.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 Graphics View(s) 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
showZoomButtons true or false States whether the zoom in / zoom out / home buttons should be shown in the Graphics View or not. Default: false 6.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. This will override the saved toolbar from the .ggb file / base64 string. Custom tools are numbered 100 001, 100 002, etc 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 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
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 Determines whether the Style Bar can be shown (or will be shown if just Graphics View 1 is showing)
Default: false 		4.0
randomize true or false 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.
Default: true 		6.0
randomSeed eg "randomSeed":33 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. 5.0
appletOnLoad eg function(api){ api.evalCommand('Segment((1,2),(3,4))'); } JavaScript method to run when the activity is initialized (and file loaded if applicable) 5.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

Default: false

4.0
showLogging true or false Determines whether logging is shown in the Browser's console
Default: false 		4.2
capturingThreshold integer 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.
Default: 3 		4.4
enableFileFeatures true or false Determines whether file saving, file loading, sign in and Options > Save settings are enabled. This argument is ignored when menubar is not showing.
Default: true 		5.0
enableUndoRedo true or false Determines whether Undo and Redo icons are shown. This argument is ignored when toolbar is not showing.
Default: true 		6.0
perspective string For values see SetPerspective_Command. Just for a blank start ie shouldn't be used with material_id, filename or ggbBase64 parameters 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 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. 5.0
preventFocus true or false When set to true, this prevents the applet from getting focus automatically at the start.
Default: false 		5.0
scaleContainerClass String Name of CSS class that is used as container; applet will scale to fit into the container. 5.0
autoHeight boolean • true to restrict the width of the applet and compute height automatically, add autoHeight:true
• falseif you want the applet to be restricted by both width and height of the container 		5.0
allowUpscale true or false Determines whether automatic scaling may scale the applet up
Default: false 		5.0
playButton true or 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.
Default: false 		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
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 shadow 6.0
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
buttonBorderColor Hex color (#RGB, #RGBA, #RRGGBB or #RRGGBBAA) 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 6.0
editorBackgroundColor Hex color Background color of the evaluator app 6.0
editorForegroundColor Hex color Foreground (text) color of the equation editor (appname = "evaluator") 6.0
textmode true or false Whether editor is in text mode or not (appname = "evaluator")
Default: false 		6.0
showKeyboardOnFocus "false"|"true"|"auto" Whether to show keyboard when input is focused. When set to true, keyboard is always shown, for false it never appears, for auto it's shown unless closed by user.
Default: true in evaluator app, auto in other apps 		6.0
keyboardType "scientific"|"normal"|"notes" Which keyboard is shown for equation editor (appname = "evaluator") 6.0
transparentGraphics true or false Whether the Graphics View and Graphics View 2 should be transparent 6.0
disableJavaScript true or false Whether running JavaScript from material files is disabled or not. 6.0
detachedKeyboardParent String When set, keyboard should be attached to the first element in DOM that fits the selector. 6.0
Retrieved from "http://wiki.geogebra.org/s/en/index.php?title=Reference:GeoGebra_App_Parameters&oldid=62570"
© 2024 International GeoGebra Institute