Difference between revisions of "Reference:GeoGebra App Parameters"

Revision as of 12:26, 25 January 2014

To include a GeoGebra worksheet into a webage, first you need to upload it to GeoGebra (File -> Share) and then you can automatically get the iframe code by clicking on the "Embed" button on the material page. Here is an example:

<iframe scrolling="no"
src="http://www.geogebra.org/material/iframe/id/23587/width/1600/height/715/border/888888/rc/false/ai/false/sdz/false/smb/false/stb/false/stbh/true/ld/false/sri/false/at/preferhtml5"
width="1600px"
height="715px"
style="border:0px;">
</iframe>

Description	Code	Example
Force HTML5 on newer browsers	at	/at/preferhtml5
Enable Right Click, Zooming and Keyboard Editing	rc	/rc/true
Show Input Bar	ai	/ai/true
Enable Shift-Drag & Zoom	sdz	/sdz/true
Show Menu Bar	smb	/smb/true
Show Toolbar	stb	/stb/true
Show Toolbar Help	stbh	/stbh/true
Allow label dragging	ld	/ld/true
Show reset icon (top-right)	sri	/sri/true

Applet parameters (Advanced users only)

When you download a GeoGebra material as an offline worksheet (.zip). The following parameters may be used within the script tag including ' var parameters =':

Name (Java)	Name (HTML5)	Value	Description	Since
ggbBase64		Base64-encoded string of a .ggb file	3.2
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	data-param-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 Java only
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 Java only
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 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.	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
java_arguments	eg `-Xmx256m`	This parameter allows you to specify more memory (in megabytes) for the GeoGebra applet. Works only in Java 6 update 10 or later (will have no effect in earlier versions)	3.2 Java only
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 Java only
useBrowserForJS	`true` or `false`	Default: true Determines whether Rhino (built into GeoGebra) or the browser will be used to run JavaScript. Setting this parameter to true during export will embed all scripts into the HTML code, therefore you should re-export your construction if you want to change the value of this parameter. In GeoGebraWeb, this determines whether the JavaScript will be run from the ggb file (false) or from the HTML (true).	4.0
showLogging	`true` or `false`	Default: false Determines whether logging is shown in the Browser's console	4.2 HTML5 only
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 HTML5 only

es:Referencia:Parámetros Applet it:Riferimenti:Parametri applet fr:Référence:Paramètres Appliquette

@@ Line 42: / Line 42: @@
 !width="55%"|Description
 !Since
-|-
-|filename
-|
-|e.g. <code>file.ggb</code>
-|Path to the construction file.
-|2.5
 |-
 |ggbBase64
-|data-param-ggbbase64
 |
 |Base64-encoded string of a .ggb file
 |3.2
-|-
-|type
-|
-|<code>button</code>
-|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>
-|2.5 - 3.2
-|-
-|framePossible
-|
-|<code>true</code> or <code>false</code>
-|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>
-|2.5 - 3.2
-|-
-|bgcolor
-|
-|e.g. <code>#FFFFFF</code> for white
-|Background color (as hex rgb string) of the applet. This parameter is only used if type "button" was set. Default: white
-|2.5
 |-
 |borderColor
-|
 |e.g. <code>#FFFFFF</code> for white
 |Color of the border line drawn around the applet panel&nbsp;(as hex rgb string). Default: gray
 |3.0
-|-
-|enableChooserPopups
-|
-|<code>true</code> or <code>false</code>
-|Controls whether a popup menu is shown or not when you click on multiple objects. Default: true<br><b>Deprecated from GeoGebra 4</b>
-|3.2
 |-
 |enableRightClick
-|data-param-enableRightClick
 |<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). Default: true
@@ Line 92: / Line 59: @@
 |-
 |enableLabelDrags
-|data-param-enableLabelDrags
 |<code>true</code> or <code>false</code>
 |States whether labels can be dragged. Default: true
-|3.2
-|-
-|allowRescaling
-|
-|<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
 |3.2
 |-
@@ Line 110: / Line 70: @@
 |-
 |errorDialogsActive
-|
 |<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
-|3.2
+|3.2 Java only
 |-
 |showMenuBar
-|data-param-showMenuBar
 |<code>true</code> or <code>false</code>
 |States whether the menubar of GeoGebra should be shown in the applet. Default: false
@@ Line 122: / Line 80: @@
 |-
 |showToolBar
-|data-param-showToolBar
 |<code>true</code> or <code>false</code>
 |States whether the toolbar with the construction mode buttons should be shown in the applet. Default: false
 |2.5
-|-
-|maxIconSize
-|
-|16 to 32
-|Maximum size of icons used in the toolbar in pixels. Default: 32
-|3.2
 |-
 |showToolBarHelp
-|
 |<code>true</code> or <code>false</code>
 |States whether the toolbar help text right to the toolbar buttons should be shown in the applet
-|3.0
+|3.0 Java only
 |-
 |customToolBar
-|data-param-customToolBar
 |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.
@@ Line 146: / Line 95: @@
 |-
 |showAlgebraInput
-|data-param-showAlgebraInput
 |<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
@@ Line 152: / Line 100: @@
 |-
 |showResetIcon
-|data-param-showResetIcon
 |<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
@@ Line 158: / Line 105: @@
 |-
 |language
-|data-param-language
 |[[w:List_of_ISO_639-1_codes|iso language string]]
   en ... English
@@ Line 171: / Line 117: @@
 |-
 |country
-|data-param-country
 |iso country string, e.g. <code>AT</code> for Austria
 |This parameter only makes sense if you use it together with the language parameter.
 |2.5
 |-
-|ggbOnInitParam
+|ggbOnInitParam/data-param-id
-|data-param-id
 |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 this example] (will have no effect in earlier versions)
@@ Line 183: / Line 127: @@
 |-
 |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 Java only
 |-
 |allowStyleBar
-|
 |<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)
-|4.0
+|4.0 Java only
 |-
 |useBrowserForJS
-|data-param-useBrowserForJS
 |<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. Setting this parameter to true during export will embed all scripts into the HTML code, therefore you should re-export your construction if you want to change the value of this parameter. <br> In GeoGebraWeb, this determines whether the JavaScript will be run from the ggb file (false) or from the HTML (true).
 |4.0
 |-
-|
+|showLogging
-|data-param-showLogging
 |<code>true</code> or <code>false</code>
 |Default: false<br>Determines whether logging is shown in the Browser's console
-|4.2
+|4.2 HTML5 only
 |-
-|
+|capturingThreshold
-|data-param-capturingThreshold
 |integer
 |Default: 3<br>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
+|4.4 HTML5 only
 |}