Riferimenti:API delle app GeoGebra

Questo documento descrive i metodi pubblici disponibili in geogebra.GeoGebraApplet e utilizzabili in una pagina HTML con JavaScript.

Esempi

Esempio: Il seguente codice HTML aggiunge un pulsante "Ripristina" a una pagina HTML, in modo da consentire all'utente il ripristino della costruzione allo stato iniziale:
<form>
<input type="button" value="Ripristina" onclick="document.applets[0].reset();">
</form>

Esempio: Questo codice aggiunge i pulsanti "Nascondi A" e "Mostra A", per modificare lo stato di visibilità di un oggetto di nome "A" presente nella costruzione:
<form>
<input type="button" value="Nascondi A" onclick="document.applets[0].setVisible('A', false);">
<input type="button" value="Mostra A" onclick="document.applets[0].setVisible('A', true);">
</form>

Esempio: Una funzione JavaScript "miaPiccolaCostruzione()" è ora utilizzata per chiamare alcuni metodi di GeoGebraApplet.

Note: La lingua è impostata in Italiano ("it"), utilizzando il parametro "language" nelle tag dell'applet, per fare in modo che sia riconosciuto il comando Retta nella versione italiana.

<applet name="ggbApplet" code="geogebra.GeoGebraApplet" archive="geogebra.jar" width=200 height=40>
<param name ="fileName" value="circle.ggb">
<param name ="framePossible" value="false">
<param name ="language" value="it">
<a href="http://www.java.com"> Installare Java 1.4.2</a> (o successivi) per utilizzare questa pagina.
</applet>
<script type="text/javascript">
function miaPiccolaCostruzione(){
var applet = document.ggbApplet;
applet.evalCommand("A = (1,1)");
applet.evalCommand("B = (3,2)");
applet.evalCommand("s = Retta[A, B]");
}
</script>
<form>
<input type="button" value="Esegui costruzione" onclick="miaPiccolaCostruzione();">
</form>

Esempio: Consultare il codice sorgente del seguente foglio di lavoro, che utilizza JavaScript. http://www.geogebra.org/source/program/applet/geogebra_applet_javascript_test.htm

Esempio: Questo foglio di lavoro utilizza un add listener in modo da verificare se è già stata completata una precedente costruzione (nel cui caso appare la scritta "Well done"). http://www.geogebra.org/en/examples/javascriptAutomaticCheckingExercise.html

Metodi disponibili

Segnatura del metodo	Da	Descrizione
evalCommand(comando)	3.0	Valuta il comando come se fosse digitato direttamente nella barra di inserimento di GeoGebra. Restituisce se la valutazione del comando ha avuto successo. È possibile passare più comandi contemporaneamente, separandoli con \n. Esempio: evalCommand("s = Retta[A, B]"). Note: Utilizzare il parametro language per fare in modo che siano applicati i comandi localizzati nella lingua corrente.
setUndoPoint()	3.2	Imposta un punto di annullamento. Utile se si vuole fare in modo che l'utente possa annullare l'azione di evalCommand, ad esempio nel caso in cui sia stato creato un pulsante HTML che agisce da strumento personalizzato

Con questi metodi è possibile implementare la comunicazione da Applet a JavaScript. Utilizzando uno dei seguenti metodi, assicurarsi di avere inserito l'opzione MAYSCRIPT al termine della prima riga del tag dell'applet. Ad esempio:

 <applet name="ggbApplet" code="geogebra.GeoGebraApplet" codebase="." archive="geogebra.jar" width="500" height="250" MAYSCRIPT>

L'opzione MAYSCRIPT è necessaria solo per le comunicazioni da GeoGebraApplet a JavaScript; non è invece richiesta affinché JavaScript possa accedere ai metodi di GeoGebraApplet.

Ad esempio, i seguenti metodi possono essere utilizzati per:

• monitorare le azioni dell'utente (vedere esempio java2javascript ), oppure
• stabilire una comunicazione tra due applet di GeoGebra (vedere esempio java2java ).

Impostare lo stato degli oggetti

Metodi generali

Segnatura del metodo	Da	Descrizione
deleteObject(nome)	2.7	Elimina l'oggetto avente il nome indicato. Esempio: deleteObject("A")
setValue(nome, valore)	3.2	Imposta il valore dell'oggetto avente il nome indicato. Note: Se l'oggetto specificato è una variabile booleana, utilizzare il valore 1 per impostarla true e un qualsiasi altro valore per impostarla false. Per oggetti di tipo diverso, non si ha alcun effetto. Esempio: setValue("a",3)
setCoords(nome, x, y)	3.0	Imposta le coordinate dell'oggetto avente il nome indicato. Note: Se l'oggetto specificato non è un punto o un vettore, non si ha alcun effetto. Esempio: setCoords("P",3,-1)
setColor(nome, intero rosso, intero verde, intero blu)	2.7	Imposta il colore (RGB) dell'oggetto avente il nome indicato. Esempio: setColor("a",100,200,300)
setVisible(nome, booleano)	2.7	Mostra (true) o nasconde (false) nella Vista Grafica l'oggetto avente il nome indicato. Esempio: setVisible("P",false)
setLabelVisible(nome, booleano)	3.0	Mostra (true) o nasconde (false) nella Vista Grafica l'etichetta dell'oggetto avente il nome indicato. Esempio: setLabelVisible("P",false)
setLabelStyle(nome, intero)	3.0	Imposta lo stile dell'etichettatura nella Vista Grafica dell'oggetto indicato. Gli stili di etichettatura disponibili sono: Nome = 0, Nome e valore = 1, Valore = 2 e Legenda = 3 Esempio: setLabelStyle("a",2)
setFixed(nome, booleano)	3.0	Imposta l'oggetto indicato come fissato (true) o libero (false). Note: Gli oggetti fissati non possono essere modificati. Esempio: setFixed("P", true)
setTrace(nome, booleano)	3.0	Attiva (true) o disattiva (false) la traccia dell'oggetto indicato. Esempio: setTrace("P",true)
renameObject(vecchio nome, nuovo nome)	3.2	Rinomina l'oggetto da vecchio nome in nuovo nome. Indica se l'operazione ha avuto successo. Esempio: renameObject("a","base")
setLayer(nome, intero)	3.2	Imposta il livello dell'oggetto indicato.
setLayerVisible(intero, booleano)	3.2	Mostra o nasconde tutti gli oggetti appartenenti al livello indicato.
setLineStyle(nome, intero)	3.2	Imposta lo stile del tratto dell'oggetto indicato (da 0 a 4).
setLineThickness(nome, intero)	3.2	Imposta lo spessore (da 1 a 13, -1 è l'impostazione predefinita) del tratto dell'oggetto indicato.
setPointStyle(nome, intero)	3.2	Imposta lo stile del punto indicato (-1 predefinito, 0 pallino pieno, 1 pallino vuoto, 2 croce, 3 più, 4 rombo pieno, 5 rombo vuoto, 6 triangolo (nord), 7 triangolo (sud), 8 triangolo (est), 9 triangolo (ovest)).
setPointSize(nome, intero)	3.2	Imposta le dimensioni (da 1 a 9) del punto indicato.
setFilling(nome, numero)	3.2	Imposta il riempimento di un oggetto (da 0 a 1).
getPNGBase64(scala, booleano trasparenza, DPI)	4.0	Restituisce la Vista Grafica 1 come stringa codificata in base64 Esempio: var str = ggbApplet.getPNGBase64(1, true, 72);
writePNGtoFile(nome file, scala, booleano trasparenza, DPI)	4.0	Esporta la Vista Grafica 1 in un file .PNG (solo applet con firma) Esempio: var success = ggbApplet.writePNGtoFile("c:\\test.png", 1, false, 300);
isIndependent(nome)	4.0	Verifica se l'oggetto avente il nome indicato è indipendente.
isMoveable(nome)	4.0	Verifica se l'oggetto avente il nome indicato è movibile.
getBase64()	4.0	Ottiene la costruzione corrente come file .ggb con codifica base64.
setBase64(stringa)	4.0	Imposta la costruzione corrente a partire da un file .ggb con codifica base64.

Animazione automatica

Segnatura del metodo	Da	Descrizione
setAnimating(nome, booleano)	3.2	Imposta la possibilità di animare un oggetto (true = attiva, false = non attiva). Per avviare l'animazione utilizzare startAnimation().
setAnimationSpeed(nome, numero)	3.2	Imposta la velocità di animazione di un oggetto.
startAnimation()	3.2	Avvia l'animazione automatica di tutti gli oggetti che possono essere animati.
stopAnimation()	3.2	Interrompe l'animazione di tutti gli oggetti in movimento.
isAnimationRunning()	3.2	Restituisce un booleano che indica se un'animazione è attiva o non attiva.

Ottenere lo stato degli oggetti

Segnatura del metodo	Da	Descrizione
getXcoord(nome)	2.7	Restituisce l'ascissa dell'oggetto avente il nome indicato. Note: Restituisce 0 se l'oggetto non è un punto o un vettore.
getYcoord(nome)	2.7	Restituisce l'ordinata dell'oggetto avente il nome indicato. Note: Restituisce 0 se l'oggetto non è un punto o un vettore.
getValue(nome)	3.2	Restituisce il valore dell'oggetto indicato (ad es. la lunghezza di un segmento, l'area di un poligono). Note: Restituisce 1 se l'oggetto è una variabile booleana a valore true. In ogni altro caso restituisce 0.
getColor(nome)	2.7	Restituisce il colore dell'oggetto indicato sotto forma di stringa esadecimale, ad es. "#FF0000" è il rosso. La stringa esadecimale inizia sempre con # e non contiene lettere minuscole.
getVisible(nome)	3.2	Restituisce true o false a seconda che l'oggetto sia visibile o meno nella Vista Grafica. Restituisce false se l'oggetto non esiste.
getValueString(nome)	2.7	Restituisce una stringa contenente il valore dell'oggetto indicato.
getDefinitionString(nome)	2.7	Restituisce una stringa contenente la definizione dell'oggetto indicato.
getCommandString(nome)	2.7	Restituisce una stringa contenente il comando utilizzato per generare l'oggetto indicato.
getObjectType(nome)	2.7	Restituisce una stringa contenente il tipo dell'oggetto indicato (come"punto", "retta", "circonferenza", ecc.).
exists(nome)	2.7	Restituisce un booleano che indica se l'oggetto avente il nome indicato esiste (true) o no (false) nella costruzione.
isDefined(nome)	2.7	Restituisce un booleano che indica se il valore dell'oggetto indicato è correntemente valido (true) o no (false).
getObjectNumber()	3.0	Restituisce il numero di oggetti nella costruzione.
getObjectName(intero)	3.0	Restituisce il nome dell'n-esimo oggetto della costruzione.
getLayer(nome)	3.2	Restituisce il livello a cui appartiene l'oggetto indicato.
getLineStyle(nome)	3.2	Rileva lo stile della linea dell'oggetto indicato (da 0 a 4).
getLineThickness(nome)	3.2	Rileva lo spessore della linea (da 1 a 13).
getPointStyle(nome)	3.2	Rileva lo stile dei punti (-1 predefinito, 0 pallino pieno, 1 pallino vuoto, 2 croce, 3 più, 4 rombo pieno, 5 rombo vuoto, 6 triangolo (nord), 7 triangolo (sud), 8 triangolo (est), 9 triangolo (ovest)).
getPointSize(nome)	3.2	Rileva la dimensione (da 1 a 9) del punto indicato.
getFilling(nome)	3.2	Rileva il riempimento (da 0 a 1) dell'oggetto indicato.

Costruzione / Interfaccia utente

Segnatura del metodo	Da	Descrizione
setMode(numero modalità)	2.7	Imposta la modalità (cioè lo strumento selezionato) nella Vista Grafica. {{Example|1=setMode(0) per impostare la modalità Muovi. (vedere Riferimenti: barra degli strumenti e i parametri dell'applet "showToolBar" and  "customToolBar" )
openFile(URL)	2.7	Apre una costruzione presente in un file (indicato da una stringa con URL assoluto o relativo)
reset()	2.7	Ricarica la costruzione iniziale (indicata nel parametro filename) dell'applet corrente.
refreshViews()	2.7	Aggiorna tutte le Viste. Note: Tutte le tracce presenti nella Vista Grafica saranno eliminate.
setOnTheFlyPointCreationActive(booleano)	3.2	Attiva (true) o disattiva (false) la creazione immediata di punti nella Vista Grafica. Note: Utile per evitare la creazione di punti come "effetto collaterale" di uno strumento. Ad esempio, quando questa flag è false, lo strumento "Retta - per due punti" non crea punti quando si fa clic nella Vista Grafica.
hideCursorWhenDragging(booleano)	3.2	Nasconde (true) o mostra (false) il cursore del mouse (puntatore) quando si trascina un oggetto per modificare la costruzione.
setRepaintingActive(booleano)	2.7	Attiva (true) o disattiva (false) il ricalcolo dell'applet. Note: Questo metodo è efficiente specialmente quando vengono invocati più metodi.
setErrorDialogsActive(booleano)	3.0	Attiva (true) o disattiva (false) la visualizzazione di finestre di dialogo relative agli errori. Note: Molto utile se utilizzato assieme a evalCommand().
setCoordSystem(xmin, xmax, ymin, ymax)	3.0	Imposta il sistema di coordinate cartesiane della Vista Grafica. Esempio: setCoordSystem(-5,10,-1,20)
setAxesVisible(booleano asseX, booleano asseY)	3.0	Mostra o nasconde gli assi x e y del sistema di coordinate della Vista Grafica. Esempio: setAxesVisible(true, false)
setGridVisible(booleano)	3.0	Mostra (true) o nasconde (false) la griglia della Vista Grafica.

Comunicazione tra GeoGebraApplet e JavaScript

I seguenti metodi consentono l'implementazione della comunicazione tra Applet e JavaScript. Assicurarsi di avere inserito l'opzione MAYSCRIPT al termine della prima riga di tag dell'applet ogni volta che si utilizzano i metodi indicati di seguito. Ad esempio:

<applet name="ggbApplet" code="geogebra.GeoGebraApplet" codebase="." archive="geogebra.jar" width="500" height="250" MAYSCRIPT>. L'opzione MAYSCRIPT è necessaria solo per la comunicazione da GeoGebraApplet a JavaScript; non è necessaria a JavaScript per accedere ai metodi di GeoGebraApplet. Ad esempio, questi metodi possono essere utilizzati per:

• monitorare le attività dell'utente (vedere esempio java2javascript)
• stabilire una comunicazione tra due applet di GeoGebra (vedere esempio java2java)

Segnatura del metodo	Da	Descrizione
registerAddListener(nome funzione JS)	3.0	Registra una funzione JavaScript come add listener per la costruzione dell'applet. Ogniqualvolta viene creato un nuovo oggetto nella costruzione della GeoGebraApplet, viene chiamata la funzione JavaScript dal nome indicato, avente come singolo argomento il nome dell'oggetto appena creato. Esempio: Registrare innanzitutto una funzione listener JavaScript: ggbApplet.registerAddListener("miaFunzioneAggiungiListener"); Quando viene creato un oggetto "A", l'applet di GeoGebra chiama la funzione Javascript miaFunzioneAggiungiListener("A");
unregisterAddListener(nome funzione JS)	3.0	Rimuove un add listener precedentemente registrato, vedere registerAddListener()
registerRemoveListener(nome funzione JS)	3.0	Registra una funzione JavaScript come remove listener per la costruzione dell'applet. Ogniqualvolta un oggetto viene eliminato dalla costruzione presente in GeoGebraApplet, viene chiamata la funzione JavaScript dal nome indicato, utilizzando come singolo argomento il nome dell'oggetto eliminato. Template:Nota Esempio: Registrare innanzitutto una funzione listener JavaScript: ggbApplet.registerRemoveListener("miaFunzioneRimuoviListener"); Quando viene eliminato un oggetto "A", l'applet di GeoGebra chiama la funzione Javascript miaFunzioneRimuoviListener("A");
unregisterRemoveListener(nome funzione JS)	3.0	Rimuove un remove listener precedentemente registrato, vedere registerRemoveListener()
registerUpdateListener(nome funzione JS)	3.0	Registra una funzione JavaScript come update listener per la costruzione dell'applet. Ogniqualvolta un oggetto viene aggiornato nella costruzione presente in GeoGebraApplet, viene chiamata la funzione JavaScript dal nome indicato, utilizzando come singolo argomento il nome dell'oggetto aggiornato. Note: Se si desidera un listen relativo esclusivamente all'aggiornamento di un determinato oggetto, è meglio utilizzare registerObjectUpdateListener() . Esempio: Registrare innanzitutto una funzione listener JavaScript: ggbApplet.registerUpdateListener("miaFunzioneAggiornaListener"); Quando viene aggiornato un oggetto "A", l'applet di GeoGebra chiama la funzione Javascript miaFunzioneAggiornaListener("A");
unregisterUpdateListener(nome funzione JS)	3.0	Rimuove un update listener precedentemente registrato, vedere registerUpdateListener()
registerObjectUpdateListener(nome, nome funzione JS)	3.0	Registra una funzione JavaScript come update listener per un singolo oggetto. Ogniqualvolta l'oggetto avente il nome indicato viene aggiornato, viene chiamata la funzione JavaScript avente il nome indicato, utilizzando come singolo argomento il nome dell'oggetto aggiornato. Se il nome dell'oggetto è stato precedentemente associato a una funzione di mapping JavaScript, verrà sostituito il valore precedente. Note: Quando la costruzione viene cancellata, o un oggetto viene eliminato, i listener aggiornati relativi alla costruzione o all'oggetto vengono rimossi dalla registrazione: vedere registerRemoveListener() and registerClearListener(). Esempio: Registrare innanzitutto una funzione listener JavaScript: ggbApplet.registerObjectUpdateListener("A", "miaFunzioneListenerAggOgg"); Quando viene aggiornato un oggetto "A", l'applet di GeoGebra chiama la funzione Javascript miaFunzioneListenerAggOgg("A"); {{Note|1= Un update listener di un oggetto continua a funzionare anche dopo che l'oggetto viene rinominato.
unregisterObjectUpdateListener(nome)	3.0	Rimuove un update listener precedentemente registrato, relativo all'oggetto avente il nome indicato, vedere registerObjectUpdateListener()
registerRenameListener(nome funzione JS)	3.0	Registra una funzione JavaScript come rename listener per la costruzione dell'applet. Ogniqualvolta un oggetto viene rinominato nella costruzione, viene chiamata la funzione JavaScript dal nome indicato e avente per argomenti il vecchio nome e il nuovo nome dell'oggetto. Esempio: Registrare innanzitutto una funzione listener JavaScript: ggbApplet.registerRenameListener("miaFunzioneListenerRinomina"); Quando un oggetto "A" viene rinominato come "B", l'applet di GeoGebra chiama la funzione Javascript miaFunzioneListenerRinomina("A", "B");
unregisterRenameListener(nome)	3.0	Rimuove un rename listener precedentemente registrato, vedere registerRenameListener()
registerClearListener(nome funzione JS)	3.0	Registra una funzione JavaScript come clear listener per la costruzione dell'applet. Ogniqualvolta la costruzione in GeoGebraApplet viene svuotata (cioè vengono rimossi tutti gli oggetti), viene chiamata la funzione JavaScript dal nome indicato, senza argomenti. Note: Quando una costruzione viene svuotata, tutte le registrazioni relative agli update listener vengono rimosse. Vedere registerUpdateListener() e registerRemoveListener(). Esempio: Registrare innanzitutto una funzione listener JavaScript: ggbApplet.registerClearListener("miaFunzioneListenerSvuota"); Quando la costruzione viene svuotata (cioè all'apertura di un nuovo file o dopo un ripristino della costruzione), l'applet di GeoGebra chiama la funzione Javascript miaFunzioneListenerSvuota();
unregisterClearListener(nome funzione JS)	3.0	Rimuove un clear listener precedentemente registrato, vedere registerClearListener()

Il formato XML di GeoGebra

Con questi metodi è possibile impostare la costruzione (vedere Riferimenti XML ).

Segnatura del metodo	Da	Descrizione
evalXML(Stringa xml)	2.7	Valuta la stringa XML e modifica di conseguenza la costruzione corrente. Note: La costruzione NON viene svuotata dai relativi elementi prima della valutazione della stringa XML.
setXML(Stringa xml)	2.7	Valuta la stringa XML e modifica di conseguenza la costruzione corrente. Note: La costruzione viene svuotata dai relativi elementi prima della valutazione della stringa XML. Questo metodo può essere utilizzato per caricare le costruzioni.
getXML()	2.7	Restituisce la costruzione corrente in formato XML di GeoGebra. Questo metodo può essere utilizzato per salvare le costruzioni.
getXML(nome)	3.2	Restituisce la stringa XML di GeoGebra relativa all'oggetto indicato, cioè viene restituito solo il tag dell'<elemento>.
getAlgorithmXML(nome)	3.2	Viene restituita la stringa XML dell'algoritmo ascendente e di tutti gli oggetti generati dall'elemento avente il nome indicato. Se non viene passato alcun nome di oggetto, questo metodo restituisce "" .

Varie

Segnatura del metodo	Da	Descrizione
evalMathPiper(stringa)	3.2	Passa la stringa indicata a MathPiper e restituisce il risultato come stringa. Rimosso in GeoGebra 4.0 - sarà sostituito in GeoGebra 4.2 da evalGeoGebraCAS()
getIPAddress()	3.2	Restituisce l'indirizzo IP del computer locale, come stringa. - ad es.v"192.168.0.4"
getHostname()	3.2	Restituisce il nome host del computer locale come stringa.
debug(stringa)	3.2	Stampa la stringa indicata nella Console Java.