Difference between revisions of "Reference:GeoGebra Apps Embedding"

From GeoGebra Manual
Jump to: navigation, search
(https://download.geogebra.org/package/geogebra-math-apps-bundle)
(35 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Reference}}
+
This page describes how to embed GeoGebra Apps into your website. For more information on how to interact with embedded apps, please see [[Reference:GeoGebra_Apps_API|GeoGebra Apps API]].  
This article describes how to embed GeoGebra Math Apps into your website or offline HTML materials using Javascript.
 
{{Note|Alternative solution is to embed materials from GeoGebra Materials Platform in your website as an iframe. See [[Reference:Material_Embedding_(Iframe)]] for details.}}
 
=Location of Math Apps=
 
You can use Math Apps from our CDN (app.geogebra.org) or you can download them as ''Math Apps Bundle'' that you can host on your own server or use offline.
 
  
[https://www.geogebra.org/partner/portal Download Math Apps Bundle]
+
=Quick Start=
=Embed using Javascript=
+
In order to embed GeoGebra apps into your page, you need to add the following three parts:
This method is recommended when multiple HTML5 applets are embedded in one page, or if you need to use the [https://www.geogebra.org/manual/en/Reference:JavaScript JavaScript API]. In this case they can share one instance of the GeoGebra codebase and load faster.
 
Here is an example web page that shows how to embed applets: [http://dev.geogebra.org/examples/geogebra-applet-embed/example2.html Example page].
 
  
You need to include the following three parts in your HTML file:
+
{{Step|num=1}} Make sure you have this in the <code>&lt;head></code> section to make sure scaling works correctly:
 +
<pre>    <meta name=viewport content="width=device-width,initial-scale=1"></pre>
  
{{Step|num=1}} The javascript library deployggb.js needs to be included with this tag:
+
{{Step|num=2}} The javascript library deployggb.js needs to be included with this tag:
 +
<pre>    <script src="https://cdn.geogebra.org/apps/deployggb.js"></script></pre>
  
<pre>    <script src="https://www.geogebra.org/scripts/deployggb.js"></script></pre>
+
{{Step|num=3}} Create an element for the GeoGebra app on your page:
In case you are using the Math Apps Bundle, please use
+
<pre>    <div id="ggb-element"></div> </pre>
<pre>    <script src="GeoGebra/deployggb.js"></script></pre>
 
{{Step|num=2}} For each applet a javaScript object of the type GGBApplet needs to be created. It takes at least the material ID from tube as a parameters.
 
  
Here is the according code from the [http://dev.geogebra.org/examples/html/example2.html example page] that creates 2 applets:
+
{{Step|num=4}} Configure and insert the app:
     var applet1 = new GGBApplet({material_id: "17499", borderColor:"#55FF00"}, true);
+
<pre><script> 
     var applet2 = new GGBApplet({filename: "../ggb/sine-curves.ggb","showtoolbar":true}, true);
+
     var ggbApp = new GGBApplet({"appName": "graphing", "width": 800, "height": 600, "showToolBar": true, "showAlgebraInput": true, "showMenuBar": true }, true);
 +
     window.addEventListener("load", function() {  
 +
        ggbApp.inject('ggb-element');
 +
    });
 +
</script></pre>
  
The above example shows how to load a file using the filename or the id of the material on GeoGebra Materials Platform. For offline use you will need to specify the file using a base64 encoded string.
+
Simply change the <code>appName</code> parameter from <code>graphing</code> to <code>geometry</code> or <code>3d</code> to get one of our other apps. To load an activity you can use eg <code>"material_id":"RHYH3UQ8"</code> and you can customize our apps further by using various [[Reference:GeoGebra_App_Parameters|GeoGebra App Parameters]].
  
When used with the id parameter, the applet will be created using the dimensions (width and height) and the applet parameters defined in the material settings on GeoGebra Materials Platform. Optionally you can override these settings by passing them in the parameters. See [[Reference:Applet_Parameters]] for a list of applet parameters.
+
=Live Examples=
 +
The following examples and their html source code show how to use GeoGebra apps either embedded in your page or in popup dialogs:
 +
* [http://dev.geogebra.org/examples/html/example-graphing.html Graphing Calculator embedded]
 +
* [http://dev.geogebra.org/examples/html/example-geometry.html Geometry app embedded]
 +
* [http://dev.geogebra.org/examples/html/example-popup-graphing.html Graphing Calculator popup]
 +
* [http://dev.geogebra.org/examples/html/example-popup-geometry.html Geometry app popup]
  
In the example the parameter 'showMenuBar:true' overrides the material setting from tube to show the menu bar for applet3.
+
=GeoGebra Apps API=
 +
The following examples show how you can interact with embedded apps through the [https://wiki.geogebra.org/en/Reference:GeoGebra_Apps_API GeoGebra Apps API]:
 +
* [http://dev.geogebra.org/examples/html/example-api-multiple.html Showing & hiding objects with buttons]
 +
* [http://dev.geogebra.org/examples/html/example-api-save-state.html Saving & loading state]
 +
* [http://dev.geogebra.org/examples/html/example-api-listeners.html Listening to update, add, remove events]
  
{{Step|num=3}} Finally, you need to determine where the applet should appear in the document and inject the applet. In our example file we create a div as parent for each applet, like this:
+
=Offline and Self-Hosted Solution=
 
+
We suggest you to use the GeoGebra Apps from our global and super-fast server network cdn.geogebra.org as shown above, but in case you prefer to host and update the GeoGebra apps yourself, you can [https://download.geogebra.org/package/geogebra-math-apps-bundle download our GeoGebra Math Apps Bundle]
<pre>    <div id="applet_container1"></div></pre>
+
The embed codes are almost the same as above, with two differences: the tag for including deployggb.js needs to be changed to
 
+
<pre>    <script src="GeoGebra/deployggb.js"></script></pre>
At the end of the script section the applets are injected to this divs using the inject function:
+
and you need to include the following line before the inject() call:
<pre>    window.onload = function() {
+
<pre>    ggbApp.setHTML5Codebase('GeoGebra/HTML5/5.0/web3d/');</pre>
        applet1.inject('applet_container1', 'preferHTML5');
 
        applet2.inject('applet_container2', 'preferHTML5');
 
        applet3.inject('applet_container3', 'preferHTML5');
 
    }</pre>
 
 
 
The parameters of the method <code>inject()</code> are:
 
<table style="width: 100%;" class="pretty">
 
    <tr>
 
      <th>Parameter</th>
 
      <th>Description</th>
 
    </tr>
 
    <tr>
 
      <td>containerID</td>
 
      <td> A string with the id of the HTML object that will be the parent of the applet. </td>
 
    </tr>
 
    <tr>
 
      <td>appletType</td>
 
      <td> This can be one of the following keywords:
 
; preferHTML5 (default)
 
: use HTML5 whenever possible (on tablets and with modern browsers), only fall back on Java otherwise (e.g. with Internet Explorer 8)
 
; html5
 
: force HTML5 to be used -- prevents Java from loading, old browser users won't be able to use the applet
 
Other values are deprecated.
 
      </td>  
 
      </tr>
 
</table>
 
=Examples=
 
* [http://dev.geogebra.org/examples/html/example1.html Single applet]
 
* [http://dev.geogebra.org/examples/html/example6.html Single applet 3D]
 
* [http://dev.geogebra.org/examples/html/example2.html Two applets]
 
* [http://dev.geogebra.org/examples/html/example3.html Single applet + API]
 
* [http://dev.geogebra.org/examples/html/example4.html Two applets + API]
 
* [http://dev.geogebra.org/examples/html/example5.html Single applet + API]
 
* [http://dev.geogebra.org/examples/html/example7.html Apps with toolbar]
 
* [http://dev.geogebra.org/examples/html/example8.html Event listeners]
 
* [http://dev.geogebra.org/examples/html/example9.html Communication between applets]
 
* [http://dev.geogebra.org/examples/html/example10.html Exercise]
 
 
 
[[es:Referencia:Applet Embebido]]
 
[[fr:Référence:Appliquettes_imbriquées]]
 
[[it:Riferimenti:Incorporare_Applet]]
 

Revision as of 09:09, 8 May 2018

This page describes how to embed GeoGebra Apps into your website. For more information on how to interact with embedded apps, please see GeoGebra Apps API.

Quick Start

In order to embed GeoGebra apps into your page, you need to add the following three parts:

1 Make sure you have this in the <head> section to make sure scaling works correctly:

    <meta name=viewport content="width=device-width,initial-scale=1">

2 The javascript library deployggb.js needs to be included with this tag:

    <script src="https://cdn.geogebra.org/apps/deployggb.js"></script>

3 Create an element for the GeoGebra app on your page:

    <div id="ggb-element"></div> 

4 Configure and insert the app:

<script>  
    var ggbApp = new GGBApplet({"appName": "graphing", "width": 800, "height": 600, "showToolBar": true, "showAlgebraInput": true, "showMenuBar": true }, true);
    window.addEventListener("load", function() { 
        ggbApp.inject('ggb-element');
    });
</script>

Simply change the appName parameter from graphing to geometry or 3d to get one of our other apps. To load an activity you can use eg "material_id":"RHYH3UQ8" and you can customize our apps further by using various GeoGebra App Parameters.

Live Examples

The following examples and their html source code show how to use GeoGebra apps either embedded in your page or in popup dialogs:

GeoGebra Apps API

The following examples show how you can interact with embedded apps through the GeoGebra Apps API:

Offline and Self-Hosted Solution

We suggest you to use the GeoGebra Apps from our global and super-fast server network cdn.geogebra.org as shown above, but in case you prefer to host and update the GeoGebra apps yourself, you can download our GeoGebra Math Apps Bundle The embed codes are almost the same as above, with two differences: the tag for including deployggb.js needs to be changed to

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

and you need to include the following line before the inject() call:

    ggbApp.setHTML5Codebase('GeoGebra/HTML5/5.0/web3d/');
© 2024 International GeoGebra Institute