Funktion | Erläuterung |
Scrollen | |
scrollToTop(objId) scrollToEnd(objId) |
Scrollt den Inhalt eines DOM-Elements an den Anfang bzw. an das Ende. objId: die ID des DOM-Elements |
scrollUp(objId) scrollDown(objId) |
Scrollt den Inhalt eines DOM-Elements um den Betrag der Höhe des Elements nach oben bzw. nach unten ("Blättern"). objId: die ID des DOM-Elements |
CSS-Eigenschaften Wichtig: Die nachfolgenden Funktionen rufen intern CSS-Variablen ab, die dem VE von der Visu-Engine zugewiesen wurden. Die Variablen können (und sollten ggf.) direkt verwendet werden:
|
|
visuElement_getFgColor(ve, id) | Liefert eine der 3 möglichen Vordergrundfarben (aus dem "Design") eines VE zurück. Der Rückgabewert ist ggf. bereits mit dem KO1-Wert verrechnet, gibt also den tatsächlichen gerenderten Wert an. ve: das VE-Objekt id: (optional) (leer)/0=Vordergrundfarbe, 1/2=Zusatzvordergrundfarbe 1/2 Return: Farbwert (z.B. "#ff0000"), oder die Default-Visu-Vordergrundfarbe Hinweis: Die Farbwerte stehen zudem als CSS-Variablen "--fgc0", "--fgc1" und "--fgc2" zu Verfügung. |
visuElement_getBgColor(ve, id) | Liefert eine der 3 möglichen Hintergrundfarben (aus dem "Design") eines VE zurück. Der Rückgabewert ist ggf. bereits mit dem KO1-Wert verrechnet, gibt also den tatsächlichen gerenderten Wert an. ve: das VE-Objekt id: (optional) (leer)/0=Hintergrundfarbe, 1/2=Zusatzhintergrundfarbe 1/2 Return: Farbwert (z.B. "#ff0000"), oder "none" Hinweis: Die Farbwerte stehen zudem als CSS-Variablen "--bgc0", "--bgc1" und "--bgc2" zu Verfügung. |
visuElement_getImageUrl(ve, id) | Liefert eine der 3 möglichen Bild-URLs (aus dem "Design") eines VE zurück. ve: das VE-Objekt id: (optional) (leer)/0=Hintergrundbild, 1/2=Zusatzbild 1/2 Return: Bild-URL, oder "" (leer) Hinweis: Die Bild-URLs stehen zudem als CSS-Variablen "--img0", "--img1" und "--img2" zu Verfügung. |
visuElement_getAngle(ve) | Liefert den Rotationswinkel (aus dem "Design") eines VE zurück. Der Rückgabewert ist ggf. bereits mit dem KO1-Wert verrechnet, gibt also den tatsächlichen gerenderten Wert an. ve: das VE-Objekt Return: Winkel (ggf. "0", falls keine Rotation angegeben wurde) Hinweis: Der Rotationswinkel steht zudem als CSS-Variable "--rt" zu Verfügung. |
visuElement_getOffset(ve, xy) | Liefert die relative Positionierung (aus dem "Design") eines VE zurück. Der Rückgabewert ist ggf. bereits mit dem KO1-Wert verrechnet, gibt also den tatsächlichen gerenderten Wert an. ve: das VE-Objekt xy: 0=X-Richtung, 1=Y-Richtung Return: relative Positionierung in Pixeln (ggf. "0", falls keine relative Positionierung angegeben wurde) Hinweis: Die relative Positionierung steht zudem als CSS-Variable "--dx" bzw. "--dy" zu Verfügung. |
visuElement_getScale(ve, xy) | Liefert die relative Skalierung (aus dem "Design") eines VE zurück. Der Rückgabewert ist ggf. bereits mit dem KO1-Wert verrechnet, gibt also den tatsächlichen gerenderten Wert an. ve: das VE-Objekt xy: 0=Breite, 1=Höhe Return: relative Skalierung in Pixeln (ggf. "0", falls keine relative Skalierung angegeben wurde) Hinweis: Die relative Skalierung steht zudem als CSS-Variable "--sx" bzw. "--sy" zu Verfügung. |
visuElement_getVarProperty(ve, varId) |
Liefert ggf. den Wert der Variablen "var1..20" mit der Eigenschaft "#root" (siehe Abschnitt [DEF] bzw. [PROPERTIES]) eines VE zurück.
Wichtig:
Diese Funktion liefert nur Werte für per "#root=..." verknüpfte Fonts, Animationen, Bilder, Sounds und Farben zurück!
|
visuElement_getCssProperty(ve, property, defaultValue) | Liefert eine beliebige CSS-Eigenschaft eines VE zurück. Der Rückgabewert ist ggf. bereits mit dem KO1-Wert verrechnet, gibt also den tatsächlichen gerenderten Wert an. ve: das VE-Objekt property: CSS-Eigenschaft (z.B. "padding-left") defaultValue: dieser Wert wird zurückgegeben, wenn die CSS-Eigenschaft nicht vorhanden ist Return: Wert der CSS-Eigenschaft, oder defaultValue |
Sonstige | |
visuElement_parseString(string, koValue) | Wendet einen KO-Wert (bzw. beliebigen Wert) im Kontext von "Variablen, Funktionen und Formeln***r-3" auf einen beliebigen String an. string: beliebiger String, z.B. die "Beschriftung" eines VE koValue: beliebiger Wert (typischer Weise der KO1-Wert eines VE) Return: String (z.B. wird "es ist {#} Grad" in "es ist 34 Grad" konvertiert) |
visuElement_centerAndAspect(ve, obj, scale) | Zentriert ein untergeordnetes Element in einem VE und setzt das Seitenverhältniss des Elements auf 1:1. ve: das VE-Objekt obj: das untergeordnete Element scale: (optional) Größe des Elements in Prozent Return: {x,y,w,h} x/y: Position des Elements w/h: Breite/Höhe des Elements |
canvasScale(canvas, w, h) | Skaliert ein Canvas-Element derart, dass die interne Auflösung z.B. für Retina-Displays hochgerechnet wird und liefert den Canvas-2D-Kontext zurück. canvas: das Canvas-Objekt w/h: gewünschte Breite/Höhe des Canvas in Pixeln Return: Canvas-2D-Kontext, oder false |
Mathematische Funktionen | |
math_mapValue(value, min1, max1, min2, max2) | Rechnet einen Wert innerhalb eines bestimmten Wertebereichs auf einen anderen Wertebereich um. value: der umzurechnende Wert min1/max1: der umzurechnende Wertebereich min2/max2: Ziel-Wertebereich Return: der umgerechnete Wert, oder min2 bzw. max2 falls value ungültig ist (z.B. ausserhalb des Wertebereichs liegt) |
math_polarToXY(mx, my, angle, radius) | Rechnet eine "polare Koordinate" in eine kartesische Koordinate um. mx/my: Mittelpunkt angle: Winkel radius: Radius Return: {x,y} x/y: kartesische Koordinaten |
math_rotatePoint(mx, my, x, y, angle, offsetX, offsetY) | Rotiert einen Punkt in einem kartesischen Koordinatensystem. mx/my: Rotationszentrum x/y: Koordinate des Punktes angle: Rotationswinkel offsetX/offsetY: Translation nach der Rotation (ggf. 0/0) Return {x,y} x/y: rotierte Koordinaten des Punktes |
Farben konvertieren | |
RGBtoHSV(r, g, b) | Wandelt RGB-Werte in HSV-Werte um. r/g/b: RGB-Einzelwerte im Bereich 0..255 Return: [h,s,v] oder false |
RGBtoRGBHEX(r, g, b) | Wandelt RGB-Werte in einen RGB-Hex-Wert um. r/g/b: RGB-Einzelwerte im Bereich 0..255 Return: RGB-Hex-String, oder false |
RGBHEXtoHSV(rgbHex) | Wandelt einen RGB-Hex-Wert in HSV-Werte um. rgbHex: RGB-Wert als String im Hex-Format (z.B. "00ff88") Return: [h,s,v] oder false |
RGBHEXtoRGB(rgbHex) | Wandelt einen RGB-Hex-Wert in RGB-Werte um. hsvHex: RGB-Wert als String im Hex-Format (z.B. "00ff88") Return: [r,g,b] oder false |
RGBHEXtoRGBA(rgbHex) | Wandelt einen RGB-Hex-Wert in RGBA-Werte um. Die Transparenz (A) wird dabei in Abhängigkeit von der "Helligkeit" des Farbwertes berechnet. rgbHex: RGB-Wert als String im Hex-Format (z.B. "00ff88") Return: [r,g,b,a] oder [0,0,0,0] |
RGBtoGREYSCALE(r, g, b) | Wandelt RGB-Werte in einen Helligkeitswert um. r/g/b: RGB-Einzelwerte im Bereich 0..255 Return: Helligkeit 0..255 oder false |
HSVtoRGB(h, s, v) | Wandelt HSV-Werte in RGB-Werte um. h/s/v: HSV-Einzelwerte im Bereich 0..255 Return: [r,g,b] oder false |
HSVtoHSVHEX(h, s, v) | Wandelt HSV-Werte in einen HSV-Hex-Wert um. h/s/v: HSV-Einzelwerte im Bereich 0..255 Return: HSV-Hex-String, oder false |
HSVtoRGBHEX(h, s, v) | Wandelt HSV-Werte in einen RGB-Hex-Wert um. h/s/v: HSV-Einzelwerte im Bereich 0..255 Return: RGB-Hex-String, oder false |
HSVtoRGBA(h, s, v) | Wandelt HSV-Werte in RGBA-Werte um. Die Transparenz (A) wird dabei in Abhängigkeit von der "Helligkeit" des Farbwertes berechnet. h/s/v: HSV-Einzelwerte im Bereich 0..255 Return: [r,g,b,a] oder [0,0,0,0] |
HSVHEXtoHSV(hsvHex) | Wandelt einen HSV-Hex-Wert in HSV-Werte um. hsvHex: HSV-Wert als String im Hex-Format (z.B. "00ff88") Return: [h,s,v] oder false |
HSVHEXtoRGBHEX(hsvHex) | Wandelt einen HSV-Hex-Wert in einen RGB-Hex-Wert um. hsvHex: HSV-Wert als String im Hex-Format (z.B. "00ff88") Return: RGB-Hex-String, oder false |
Funktion | Erläuterung |
Eigenschaften | |
visuElement_hasKo(veId, koId) | Ermittelt, ob dem VE ein KO1..3 zugewiesen wurde: veId: die ID des VE koId: 1..3 (für KO1/KO2/KO3 des VE - nicht die KO-ID aus der Datenbank!) Return: true=dem VE wurde das KO1..3 zugewiesen, false=kein KO1..3 zugewiesen |
visuElement_hasCommands(veId) | Ermittelt, ob dem VE Seitensteuerungen/Befehle zugewiesen wurden: veId: die ID des VE Return: true=dem VE wurden Seitensteuerungen/Befehle zugewiesen, false=keine Seitensteuerungen/Befehle zugewiesen |
visuElement_getText(veId) | Liefert die Eigenschaft "Beschriftung" des VE zurück: veId: die ID des VE Return: (String)=Beschriftung des VE |
visuElement_getCaption(veId) | Liefert die Eigenschaft "Beschriftung" des VE in reduzierter Form zurück: Es wird nur das erste Vorkommen von {...} zurückgegeben (z.B. während der Bedienung eines Drehreglers). Ist in Beschriftung keine Angabe {...} vorhanden, wird die gesamte Beschriftung zurückgegeben. Beispiel: bei "Temperatur {#*1} Grad {#*2}" wird lediglich "{#*1}" zurückgegeben. veId: die ID des VE Return: (String)=reduzierte Beschriftung des VE (oder gesamte Beschriftung) |
Klick-Funktionen | |
visuElement_onClick(obj, functionShort, [indicateShort, functionLong, indicateLong, animationLong, forceDownEvent]) | Registriert einen Klick- und/oder Langklick-Handler für ein beliebiges Element eines VE: obj: Element (eines VE), das auf einen Klick reagieren soll functionShort: die aufzurufende Funktion bei ShortClick in der Form: funktion(ve_Id,obj_Id){...} (oder false, wenn nicht beötigt) Optional: indicateShort: true=Klick-Indikator einblenden bei ShortClick, false=nicht einblenden (default=true) functionLong: die aufzurufende Funktion bei LongClick in der Form: funktion(ve_Id,obj_Id){...} indicateLong: true=Klick-Indikator einblenden bei LongClick, false=nicht einblenden (default=true) animationLong: true=LongClick-Animation einblenden, false=nicht einblenden (default=true) Hinweis: Die Parameter "ve_Id" und "obj_Id" (VE-ID und ID des angeklickten Elements) werden den Funktionen functionShort/functionLong automatisch übergeben und können dann in der entsprechenden Funktion ausgewertet werden. |
visuElement_onDown(obj, functionShort, indicateShort) | Wie "visuElement_onClick()", jedoch nur für ShortClick und es wird stets das Down-Event (nicht Klick-Event) registriert (unabhängig von der Visuaccount-Einstellung "Klickmodus"). |
Drag-Funktionen | |
visuElement_onDrag(obj, koIdInit, koId, interval) | Registriert einen Drag-Handler (Down-Event) für ein beliebiges Element "obj" eines VE: koIdInit: 1/2=der Wert des VE-KO1/2 dient als Initialwert (z.B. bei relativer Eingabe) 0=kein Initial-Wert (z.B. bei absoluter Eingabe) koId: 1/2=das VE-KO1/2 dient als Live-Vorschauwert-Provider und wird am Ende des Dragvorgangs (ggf. auch zyklisch) gesetzt 0: kein KO, d.h. keine Live-Vorschau, kein (zyklisches) Setzen - es wird nur die Drag-Funktionalität bereitgestellt (für eigene Implementierungen) interval: zyklisches Setzen von KO1/2 -1=deaktiviert, 0=aktiviert (schnellstmöglich), 1..oo=aktiviert (alle x Millisekunden) Hinweis: wenn das zyklisches Setzen aktiviert ist, wird keine Live-Vorschau erzeugt Wichtig: Der Drag-Handler erwartet diverse Funktionen (siehe Abschnitt [VISU.JS] / Drag-Operationen***r-3-2)! |
visuElement_dragStart(obj, koIdInit, koId, interval) | Wie "visuElement_onDrag()", jedoch wird kein Down-Event registriert. |
visuElement_mapDragValue(pos, koValue, format, coord, modus, minX, maxX, minY, maxY, minA, maxA, vlist, vstep, vsnap) | Ermittelt die aktuellen Werte und Cursor-Koordinaten einer Drag-Operation. pos: {x,y,w,h} relative Mausposition bezogen auf das Drag-Element und Breite/Höhe des Drag-Elements koValue: Default-KO-Wert (nur bei modus=1/2 sinnvoll) format: KO-Format: 0="X,Y" bzw. "Winkel,Radius", 1=nur "X" bzw. "Winkel", 2=nur "Y" bzw. "Radius" coord: Koordinatensystem: 0=kartesisch, 1=polar modus: Absolute oder realtive Wertänderung: 0=absolut, 1=relativ, 2=Inkrementalgeber (nur wenn format=1 und coord=1) minX/maxX: Wertebereich X: null/leer=VE-Größe in Pixeln, -∞..∞=Wertebereich minY/maxY: Wertebereich Y: null/leer=VE-Größe in Pixeln, -∞..∞=Wertebereich minA/maxA: Winkelbereich bei coord=1 (jeweils 0..360 Grad, min<max) vlist: Anzahl der Nachkommastellen des Wertes: null/leer=beliebig vstep: der Wert wird auf einen Wert mit dieser "Schrittweite" umgerechnet vsnap: (nur bei Inkrementalgeber) Anzahl der Rastungen (360 muss restlos durch vsnap teilbar sein) Return: {valuex,valuey,cursorx,cursory} oder false (Fehler) valuex/y: X/Y-Koordinaten bzw. Winkel/Radius cursorx/y: Cursor-Position (kartesisch oder polar) |
visuElement_mapDragValueReset(koValue) | Parsed intern den KO-Wert beim Start einer Drag-Operation und speichert die Mausposition (z.B. bei relativer Eingabe). Diese Funktion wird u.U. für die Funktion "visuElement_mapDragValue()" benötigt. koValue: KO-Wert |
visuElement_getDragKoValue() | Ermittelt den aktuellen (interen) Wert einer Drag-Operation. Hinweis: Normalerweise ist dies nicht erforderlich, jedoch kann auf diese Weise der aktuelle interne Wert einer Drag-Operation ausgelesen werden. Return: der aktuelle interne Wert (ggf. wird ein leerer String zurückgegeben, falls kein aktueller Wert ermittelt werden kann) |
visuElement_setDragKoValue(koValue) | Setzt den aktuellen (interen) Wert einer Drag-Operation. Hinweis: Normalerweise ist dies nicht erforderlich, jedoch kann auf diese Weise der aktuelle interne Wert einer Drag-Operation beeinflusst werden. Return: true=erfolgreich, false=Fehler |
KO setzen/lesen | |
visuElement_setKoValue(veId, koId, koValue) | Setzt das KO1..3 eines VEs auf einen Wert (asynchron): veId: die ID des VE koId: 1..3 (für KO1/KO2/KO3 des VE - nicht die KO-ID aus der Datenbank!) koValue: KO-Wert Return: true=prinzipiell erfolgreich (jedoch nicht garantiert, da asynchron), false=Fehler (z.B. KO ist nicht zugewiesen) |
visuElement_getKoValue(veId, koId) | Ermittelt den Wert von KO1..3 eines VEs: veId: die ID des VE koId: 1..3 (für KO1/KO2/KO3 des VE - nicht die KO-ID aus der Datenbank!) Return: der aktuelle KO-Wert (ggf. wird ein leerer String zurückgegeben, z.B. falls das entsprechende KO nicht zugewiesen wurde) |
setKoValue(koId, koValue) | Setzt ein beliebiges KO auf einen Wert (asynchron): koId: KO-ID aus der Datenbank koValue: KO-Wert |
Timer-Funktionen | |
visuElement_setTimeout(veId, timerId, timeout, func) | Setzt einen Timeout für ein VE (nach Ablauf des Timers wird eine Funktion aufgerufen): veId: die ID des VE timerId: für dieses VE eindeutige ID im Bereich 1..∞ (ein VE kann beliebig viele Timer verwalten) timeout: Zeit in Millisekunden func: anonyme Funktion in der Form: function(ve_Id,timer_Id){...} Hinweis: Die Parameter "ve_Id" und "timer_Id" (veId und ID des Timers) werden der anonymen Funktion "func" automatisch übergeben und können dann in der entsprechenden Funktion ausgewertet werden. |
visuElement_clearTimeout(veId, timerId) | Löschen (und abbrechen) eines zuvor mittels "visuElement_setTimeout()" definierten Timeouts: veId: die ID des VE timerId: die in "visuElement_setTimeout()" definierte ID des Timers |
Ajax | |
visuElement_callPhp(cmd, [json1, json2]) | Ruft die PHP-Funktion "PHP_VSE_VSEID()" im Abschnitt [VISU.PHP] per "Ajax" (asynchron) auf, dabei können ggf. JSON-Daten übergeben werden. Die Parameter json1/2 werden ggf. in PHP als Array in der Form $json1/2['<Name>'] bzw. $json1/2[<ID>] bereitgestellt. cmd: (String) dieser String wird an die PHP-Funktion "PHP_VSE_VSEID()" im Abschnitt [VISU.PHP] als "$cmd" übergeben json1/2: (Array oder Object) diese Daten werden ggf. an die PHP-Funktion "PHP_VSE_VSEID()" im Abschnitt [VISU.PHP] als "$json1/2" übergeben Hinweis: Intern wird die Funktion beim Einlesen der VSE-Datei um einen Parameter (VSEID) erweitert (dies legt quasi den "Sender" fest). |
Globale Variablen | |
visuElement_newGlobal(veId, obj) | Erstellt ein globales JS-Objekt für eine VE-Instanz, z.B. um eigene JS-Variablen zu deklarieren. Das globale Objekt ist dann für alle JS-Funktionen im Abschnitt [VISU.JS] verfügbar (für die entsprechende VE-Instanz). Wichtig: Pro VE ist nur das Erstellen eines globalen Objektes möglich! Das Erstellen eines globalen Objektes sollte daher ggf. in der Funktion "VSE_VSEID_CONSTRUCT()" im Abschnitt [VISU.JS] erfolgen. veId: die ID des VE obj: JS-Objekt in der Form {x:1,y:"EDOMI",z:3,...} Hinweis: Ein Entfernen/Löschen von globalen Objekten ist nicht erforderlich - die Visu-Engine verwaltet globale Objekte automatisch. |
visuElement_getGlobal(veId) | Liefert das mittels "visuElement_newGlobal()" erstellte globale Objekt zurück, so dass dieses verwendet oder modifziert werden kann. veId: die ID des VE return: das globale JS-Objekt (by-reference), oder false=nicht vorhanden |
Formulare | |
visuElement_formNewInput(veId, id, len, style) | Generiert (als String) ein Input-Control innerhalb eines VE. veId: die ID des VE id: die gewünschte (i.d.R. fortlaufende) ID des Control-Elements in der Form "0..∞" (erzeugt wird eine ID in der Form "e-<veId>-formobj<id>") len: maximale Anzahl an Zeichen style: ggf. CSS-Eigenschaften Return: (String) zurückgegeben wird ein String mit dem entsprechenden HTML-Code |
visuElement_formNewCheck(veId, id, style) | Generiert (als String) ein Checkbox-Control innerhalb eines VE. veId: die ID des VE id: die gewünschte (i.d.R. fortlaufende) ID des Control-Elements in der Form "0..∞" (erzeugt wird eine ID in der Form "e-<veId>-formobj<id>") style: ggf. CSS-Eigenschaften Return: (String) zurückgegeben wird ein String mit dem entsprechenden HTML-Code |
visuElement_formNewCheckmulti(veId, id, style) | Generiert (als String) ein Checkbox-Control mit mehreren Optionen innerhalb eines VE. veId: die ID des VE id: die gewünschte (i.d.R. fortlaufende) ID des Control-Elements in der Form "0..∞" (erzeugt wird eine ID in der Form "e-<veId>-formobj<id>") style: ggf. CSS-Eigenschaften Return: (String) zurückgegeben wird ein String mit dem entsprechenden HTML-Code |
visuElement_formNewSelect(veId, id, style) | Generiert (als String) ein Selectbox-Control innerhalb eines VE. veId: die ID des VE id: die gewünschte (i.d.R. fortlaufende) ID des Control-Elements in der Form "0..∞" (erzeugt wird eine ID in der Form "e-<veId>-formobj<id>") style: ggf. CSS-Eigenschaften Return: (String) zurückgegeben wird ein String mit dem entsprechenden HTML-Code |
visuElement_formSetControl(veId, id, option, value) |
Setzt ein erzeugtes Control (s.o.) auf einen Defaultwert und initialisiert das Control ggf. mit diversen Optionen.
Wichtig:
Diese Funktion inititalisiert das Control und muss daher stets nach dem Erzeugen eines Control und vor der Nutzung des Formulars aufgerufen werden.
veId: die ID des VE
id: die ID des Control-Elements
value: Defaultwert
option: je nach Typ des Controls werden folgende Optionen erwartet (z.B. "Werteingabe")
|
visuElement_formGetValues(veId) | Liefert ein Array aus den Werten sämtlicher Controls (s.o.) eines VE zurück. Dieses Array kann z.B. mittels der Funktion "visuElement_callPhp()" an PHP zur Auswertung übermittelt werden. Hinweis: Es werden stets die Values sämtlicher vorhandener Controls eines VEs in ein Array konvertiert. veId: die ID des VE Return: Array, die ID (key) des Arrays entspricht der ID des jeweiligen Controls |
SVG-Grafik | |
graphics_svg_icon(iconId) | Generiert ein SVG-Symbol als String. Die Größe des Symbols beträgt stets 1em (das Symbol wird also mit der Font-Größe skaliert). Wichtig: Die Symbole können u.U. in zukünftigen Versionen erweitert/verändert werden! iconId: 0="Aus" 1="Ein" 2="Hinzufügen" 3="Abspielen" 4="Aufnehmen" Return: String mit SVG-Anweisungen und SVG-Tag(!) |
graphics_svg_centerCircle(fgcolor, w, h, para) |
Generiert einen SVG-Kreis im Zentrum einer gedachten Boundingbox.
fgcolor: Farbe der Kontur (der Kreis wird nicht gefüllt, die Konturbreite beträgt stets 1px)
w/h: Größe der gedachten Boundingbox in Pixeln (der Kreis wird stets im Zentrum der Boundingbox gerendert)
para: (Objekt)
|
graphics_svg_centerArc(fgcolor, w, h, a1, a2, para) |
Generiert einen SVG-Kreisbogen im Zentrum einer gedachten Boundingbox.
fgcolor: Farbe der Kontur (der Kreisbogen wird nicht gefüllt, die Konturbreite beträgt stets 1px)
w/h: Größe der gedachten Boundingbox in Pixeln (der Kreisbogen wird stets im Zentrum der Boundingbox gerendert)
a1/a2: Start- und Endwinkel des Kreisbogens
para: (Objekt)
|
graphics_svg_centerLine(fgcolor, w, h, para) |
Generiert eine SVG-Linie im Zentrum einer gedachten Boundingbox.
fgcolor: Farbe der Linie (die Liniendicke beträgt stets 1px)
w/h: Größe der gedachten Boundingbox in Pixeln (die Linie wird stets im Zentrum der Boundingbox gerendert, je nach Seitenverhältnis vertikal oder horizontal)
para: (Objekt)
|
graphics_svg_clock(fgcolor, w, h, para, koValue) | Generiert eine SVG-Analoguhr. Details sind z.B. dem VSE 17 zu entnehmen. Return: String mit SVG-Anweisungen (jedoch ohne SVG-Tag) |
graphics_svg_gauge(fgcolor, w, h, para, koValue) | Generiert eine SVG-Wertanzeige. Details sind z.B. dem VSE 27 zu entnehmen. Return: String mit SVG-Anweisungen (jedoch ohne SVG-Tag) |
graphics_svg_scale(fgcolor, w, h, para) | Generiert eine SVG-Skala. Details sind z.B. dem VSE 35 zu entnehmen. Return: String mit SVG-Anweisungen (jedoch ohne SVG-Tag) |
Sonstige | |
visuElement_modify(veId, data) |
Ruft eine anonyme Funktion eines VE auf, nachdem sämtliche VEs aufgebaut (gerendert) wurden. Dies ermöglicht z.B. die Modifizierung der Position eines VE in Abhängigkeit von der Position anderer VEs (denn deren Position liegt ggf. erst nach dem Rendern endgültig fest).
veId: die ID des VE
data: {para,func}
|
visuElement_doCommands(veId) | Führt die einem VE ggf. zugewiesenen Seitensteuerungen/Befehle aus. veId: die ID des VE |
visuElement_indicate(obj) | Blendet einen Klick-Indikator (für 200 Millisekunden) für ein VE bzw. ein untergeordnetes DOM-Element eines VE ein. obj: VE-Objekt bzw. untergeordnetes DOM-Element eines VE (das DOM-Element muss über eine eindeutige ID verfügen) |
visuElement_getMousePosition(ve, obj, flip) | Ermittelt die relativen Mauskoordinaten eines untergeordneten DOM-Elements eines VE. Hinweis: Eine Rotation des VE wird ggf. berücksichtigt. ve: das VE-Objekt obj: untergeordnetes DOM-Element des VE (die Mauskoordinaten beziehen sich auf dieses Element) flip: optional können die ermittelten Mauskoordinaten invertiert zurückgegeben werden (0=ohne, 1=nur X, 2=nur Y, 3=X+Y) Return: (Object) {x,y,w,h,a} x/y: Mauskoordinaten (ggf. invertiert) w/h: Breite/Höhe von obj (in Pixeln) a: Rotations-Winkel des VE |
visuElement_getAbsoluteChildPosition(ve, obj) | Ermittelt die absoluten Koordinaten eines untergeordneten DOM-Elements eines VE. Hinweis: Eine Rotation des VE wird ggf. berücksichtigt. ve: das VE-Objekt obj: untergeordnetes DOM-Element des VE (die Koordinaten beziehen sich auf dieses Element) Return: {x0,y0,xm,ym} x0/y0: linke-obere Ecke xm/ym: Mittelpunkt |
Funktion | Erläuterung |
Datenbank (SQL) | |
sql_call($cmd) | Führt ein Datenbank-Kommando aus (bildet die PHP-Funktion "mysqli_query()" ab). $cmd: Kommando (z.B. "SELECT * FROM edomiLive.email" oder "UPDATE/INSERT/DELETE...") Return: mysqli_result-Objekt (für "SELECT/SHOW/etc.") oder true (bei "UPDATE/INSERT/etc.") oder false (bei Fehler) |
sql_result($sql) | Ließt einen Datensatz aus einem Abfrageergebnis und bewegt den internen Zeiger auf den nächsten Datensatz (bildet die PHP-Funktion "mysqli_fetch_assoc()" ab). $sql: mysqli_result-Objekt (Ergebnis der Abfrage durch "sql_call()") Return: Array (assoziativ), oder false (z.B. wenn keine weiteren Datensätze vorhanden sind) |
sql_close($sql) | Gibt das Ergebnis einer Datenbank-Anfrage frei (bildet die PHP-Funktion "mysqli_free_result()" ab). $sql: mysqli_result-Objekt |
sql_save($db, $condition, $arr) |
Speichert einen Datensatz in einer Tabelle. Je nach Parametern wird der Datensatz überschrieben und hinzugefügt.
Hinweis:
Alternativ kann ein Datensatz auch wie üblich (UPDATE/INSERT) mittels der Funktion "sql_call()" modifiziert/hinzugefügt werden.
$db: Datenbank- und Tabellenname (z.B. "edomiLive.email")
$condition:
|
sql_getCount($db, $condition) | Ermittelt die Anzahl der Datensätze in einer Tabelle. $db: Datenbank- und Tabellenname (z.B. "edomiLive.email") $condition: WHERE-Klausel ("SELECT...WHERE $condition") Return: Anzahl, ggf. "0" |
sql_getValue($db, $column, $condition) | Gibt den Wert genau einer Tabellenspalte eines Datensatzes zurück (es wird nur der erste Treffer berücksichtigt). $db: Datenbank- und Tabellenname (z.B. "edomiLive.email") $column: Name der Tabellenspalte (z.B. "column1") $condition: WHERE-Klausel ("SELECT...WHERE $condition") Return: Wert, oder NULL |
sql_getValues($db, $columns, $condition) | Gibt die Werte mehrerer Tabellenspalten eines Datensatzes zurück (es wird nur der erste Treffer berücksichtigt). $db: Datenbank- und Tabellenname (z.B. "edomiLive.email") $columns: Namen der Tabellenspalten (z.B. "column1,column2,column3") $condition: WHERE-Klausel ("SELECT...WHERE $condition") Return: Array (assoziativ), oder false |
Konvertierung | |
escapeString($string, [$mode]) |
Konvertiert einen String zur Ausgabe per HTML/Ajax. Anführungszeichen, Backslashes und Tabulatoren werden escaped.
$string: der zu konvertierende String
$mode: (optional) ggf. weitere Sonderzeichen escapen/konvertieren
|
sql_encodeString($string, [$mode]) |
Konvertiert einen String zum Schreiben in eine Datenbank. Anführungszeichen, Backslashes, Tabulatoren und CR/LF werden escaped, sowie einige Sonderzeichen entfernt.
Hinweis:
Je nach Modus wird entweder wie gewohnt ein String zurückgegeben, oder ein mit einfachen Anführungzeichen (nicht escaped) umschlossener String, oder der String "NULL".
$string: der zu konvertierende String
$mode: (optional)
|
sql_nearestNumber($value, $list) | Ermittelt einen nummerischen Wert aus eine Liste, der dem angegebenen Wert am nächsten kommt. $value: Wert $list: kommaseparierte Liste aus Werten (z.B. "0,1,2,3,10,20,30") Return: der am nächsten gelegene Wert aus $list, oder der erste Wert aus $list (z.B. falls der Wert nicht nummerisch ist) |