Difference between revisions of "Reference:GeoGebra Apps Embedding"

From GeoGebra Manual
Jump to: navigation, search
(For technical reasons, you need to use <code>5.2</code> not <code>5.0</code> after version 804)
 
(78 intermediate revisions by 13 users not shown)
Line 1: Line 1:
−
To include a material from GeoGebra into a webpage you can either embed it as an iframe or use the script deployggb.js to inject it directly to your webpage.
+
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]].  
  
−
__TOC__
+
=Quick Start=
−
=Embed as iframe=
+
In order to embed GeoGebra apps into your page, you need to add the following three parts:
−
You can automatically get the iframe code by clicking on the "Embed" button on the material page. Here is an example:
+
 
−
<pre>
+
{{Step|num=1}} Make sure you have this in the <code>&lt;head></code> section to make sure scaling works correctly (eg on mobile browsers) and that Unicode works
−
<iframe scrolling="no"
+
<pre><meta name=viewport content="width=device-width,initial-scale=1"> 
−
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"
+
<meta charset="utf-8"/></pre>
−
width="1600px"
+
 
−
height="715px"
+
{{Step|num=2}} The javascript library deployggb.js needs to be included with this tag:
−
style="border:0px;">
+
<pre><script src="https://www.geogebra.org/apps/deployggb.js"></script></pre>
−
</iframe>
+
 
−
</pre>
+
{{Step|num=3}} Create an element for the GeoGebra app on your page:
 +
<pre><div id="ggb-element"></div> </pre>
  
−
{| class="wikitable"
+
{{Step|num=4}} Configure and insert the app:
−
|-
+
<pre><script> 
−
! Description !! Code !! Example
+
    var params = {"appName": "graphing", "width": 800, "height": 600, "showToolBar": true, "showAlgebraInput": true, "showMenuBar": true };
−
|-
+
    var applet = new GGBApplet(params, true);
−
| Force HTML5 on newer browsers || at || /at/preferhtml5
+
    window.addEventListener("load", function() {
−
|-
+
        applet.inject('ggb-element');
−
| Enable Right Click, Zooming and Keyboard Editing || rc || /rc/true
+
    });
−
|-
+
</script></pre>
−
| 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
 
−
|}
 
  
−
=Embed using deployggb.js=
+
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> or <code>"filename":"myFile.ggb"</code> and you can customize our apps further by using various [[Reference:GeoGebra_App_Parameters|GeoGebra App Parameters]].
−
This method is recommended when multiple HTML5 applets are embedded in one page. In this case they can share one instance of the GeoGebraWeb codebase and load faster.
 
−
Here is an example web page that shows how to embed applets: [http://dev.geogebra.org/partners/geogebra-applet-embed/example1.html Example page]
 
  
−
You need to include the following three parts in your HTML file:
+
=Tutorial=
  
−
{{Step|num=1}} The javascript library deployggb.js needs to be included with this tag:
+
Please see here for a longer tutorial which explains the different embedding options:
 +
https://www.geogebra.org/m/sehv2qc9
  
−
<pre>    <script type="text/javascript" src="http://www.geogebra.org/scripts/deployggb.js"></script></pre>
+
=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]
  
−
{{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.
+
=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]
  
−
Here is the according code from the [http://dev.geogebra.org/partners/geogebra-applet-embed/example1.html example page] that creates 3 applets:
+
=Offline and Self-Hosted Solution=
−
    var applet1 = new GGBApplet({material_id: "27876"}, true);
+
We suggest you to use the GeoGebra Apps from our global and super-fast server network www.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]
−
    var applet2 = new GGBApplet({material_id: "17499", borderColor:"#55FF00"}, true);
+
The embed codes are almost the same as above, with two differences: the tag for including deployggb.js needs to be changed to
−
    var applet3 = new GGBApplet({material_id: "17501", showMenuBar:true}, true);
+
<pre>    <script src="GeoGebra/deployggb.js"></script></pre>
 +
and you need to include the following line before the inject() call:
 +
<pre>    applet.setHTML5Codebase('GeoGebra/HTML5/5.0/web3d/');</pre>
 +
Alternatively if you just need to fix to a specific version then you can still use the CDN like this (don't change the <code>5.0.</code> just the <code>498</code>)
 +
<pre>    applet.setHTML5Codebase("https://www.geogebra.org/apps/5.0.498.0/web3d");</pre>
 +
For technical reasons, you need to use <code>5.2</code> not <code>5.0</code> after version 804 eg
 +
<pre>    applet.setHTML5Codebase("https://www.geogebra.org/apps/5.2.804.0/web3d");</pre>
  
−
By default the applet will be created using the dimensions (width and height) and the applet parameters defined in the material settings on GeoGebra. Optionally you can override these settings by passing them in the parameters. See [[Reference:Applet_Parameters]] for a list of applet parameters.
+
=Adjusting embedded apps appearance=
 +
This feature is currently available only for GeoGebra Notes. To change the colors of the UI elements, you can set some CSS variables
 +
<pre>
 +
<style>
 +
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 */
 +
}
 +
</style>
 +
</pre>
  
−
In the example the parameter 'showMenuBar:true' overrides the material setting from tube to show the menu bar for applet3.
+
=Speed up loading time with a service worker=
 +
You can speed up loading of the GeoGebra library by using a service worker.
 +
To use a service worker you should set a specific version of GeoGebra using <code>setHTML5Codebase()</code>.
  
−
{{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:
+
To install the service worker, first you have to include the ''sworker-locked.js''
 +
file under your domain (e.g. ''www.example.com/path/sworker-locked.js'').
 +
The service worker file can be found under the ''GeoGebra/HTML5/5.0/web3d/'' folder
 +
in the ''GeoGebra Math Apps Bundle''.
  
−
<pre>    <div id="applet_container1"></div></pre>
+
Next, include the following snippet on the page where GeoGebra is loaded.
 +
Please change the path to the service worker. You can also set the appletLocation
 +
variable to enable the worker only in a specific folder (or leave it as '/' to use it on all pages of your domain):
  
−
At the end of the script section the applets are injected to this divs using the inject function:
+
    var serviceWorkerPath = '/sworker-locked.js'
−
<pre>    window.onload = function() {
+
    var appletLocation = '/'
−
         applet1.inject('applet_container1', 'preferHTML5');
+
   
−
         applet2.inject('applet_container2', 'preferHTML5');
+
    function isServiceWorkerSupported() {
−
         applet3.inject('applet_container3', 'preferHTML5');
+
        return 'serviceWorker' in navigator && location.protocol === "https:";
−
     }</pre>
+
    }
 +
   
 +
    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.");
 +
     }
  
−
The parameters of the method <code>inject()</code> are:
+
With this installed, when a user opens the page where the service worker is enabled,
−
<table style="width: 100%;" class="pretty">
+
the application scripts get downloaded and cached by the service worker. This way,
−
    <tr>
+
the next time that same user visits the page, the scripts are loaded from the
−
      <th>Parameter</th>
+
cache instead of downloading them again from the servers.
−
      <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)
 
−
; preferJava
 
−
: use Java when installed, otherwise use HTML5
 
−
; html5
 
−
: use HTML5 applet
 
−
; java
 
−
: use Java applet. Note: in this case your applet will not work on tablets.
 
−
; auto
 
−
: automatically decide the best technology (HTML5 or Java) based on the client and GeoGebra version number provided
 
−
      </td>   
 
−
      </tr>
 
−
</table>
 

Latest revision as of 13:12, 27 September 2023

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 (eg on mobile browsers) and that Unicode works 

<meta name=viewport content="width=device-width,initial-scale=1">  
<meta charset="utf-8"/>

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

<script src="https://www.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 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');
    });
</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" or "filename":"myFile.ggb" and you can customize our apps further by using various GeoGebra App Parameters.

Tutorial

Please see here for a longer tutorial which explains the different embedding options: https://www.geogebra.org/m/sehv2qc9

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 www.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: 

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

Alternatively if you just need to fix to a specific version then you can still use the CDN like this (don't change the 5.0. just the 498) 

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

For technical reasons, you need to use 5.2 not 5.0 after version 804 eg 

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

Adjusting embedded apps appearance

This feature is currently available only for GeoGebra Notes. To change the colors of the UI elements, you can set some CSS variables 

<style>
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 */
}
</style>

Speed up loading time with a service worker

You can speed up loading of the GeoGebra library by using a service worker. To use a service worker you should set a specific version of GeoGebra using setHTML5Codebase().

To install the service worker, first you have to include the sworker-locked.js file under your domain (e.g. www.example.com/path/sworker-locked.js). The service worker file can be found under the GeoGebra/HTML5/5.0/web3d/ folder in the GeoGebra Math Apps Bundle.

Next, include the following snippet on the page where GeoGebra is loaded. Please change the path to the service worker. You can also set the appletLocation variable to enable the worker only in a specific folder (or leave it as '/' to use it on all pages of your domain): 

   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.");
   }

With this installed, when a user opens the page where the service worker is enabled, the application scripts get downloaded and cached by the service worker. This way, the next time that same user visits the page, the scripts are loaded from the cache instead of downloading them again from the servers.

Retrieved from "http://wiki.geogebra.org/s/en/index.php?title=Reference:GeoGebra_Apps_Embedding&oldid=62388"
© 2024 International GeoGebra Institute