9. Überblick Feldfunktionen

  Liste der Feldfunktionen
@f{3dlegend} Erzeugt eine Legende für 3D-Datensätze.
@f{_a} Die Funktion gibt für einen Alias einen Ersatztext aus.
@f{ansi} Gibt ein ANSI- oder UNICODE-Zeichen aus.
@f{area} Flächenberechnung von Datensätzen.
@f{channelname} Die Feldfunktion liefert einen Kanalnamen des ersten Datensatzes des Diagramms, zu dem die Feldfunktion gehört. Die Feldfunktion kann in einem Textobjekt, einem Tabellenobjekt oder in einer Achsentitel eingetragen werden.
@f{copytextcolortocurve} Kopiert die Textfarbe des y-Titels in alle 1D- und 2D-Kurven. Die Feldfunktion muss in den Y-Titeltext eingefügt werden.
@f{createdate} Zeigt das Datum an, an dem das Dokument erzeugt wurde.
@f{cursor_value} Zeigt den x- oder y-Wert einer 2D-Kurve an der Cursor-Position an.
@f{datafilenames} Schreibt eine Liste aller Datendatei-Namen aus der Daten in der Seite geladen wurden.
@f{datasetfilter} Gibt den Filtertext (Rekord-Filter) des Datensatzes aus.
@f{date} Schreibt das aktuelle Datum.
@f{documentname} Schreibt den Namen des Dokuments.
@f{file} Schreibt den Inhalt einer Textdatei (maximal 100 Zeilen).
@f{labeldatapoint} Beschriftet die Originalpunkte des Datensatzes mit dem Wert der y-Koordinate.
@f{labeldataset} Die Feldfunktion beschriftet eine 2D-Kurve mit ihrem Legendentext oder dem Y-Kanalnamen (siehe XYSetLegendText).
@f{labelsinglepoint} Beschriftet einen einzelnen Datenpunkt.
@f{lastprintdate} Zeigt das Datum an, an dem das Dokument zuletzt gedruckt wurde.
@f{lastsavedate} Zeigt das Datum an, an dem das Dokument zum letzen Mal gespeichert wurde.
@f{legend_table} Erzeugt eine Legendentabelle für die in der Seite oder Dokument verwendeten Datendateien.
@f{legendchannel} Erzeugt eine Legende mit den y-Kanalnamen der 2D-Kurven.
@f{legendfile} Legende ausgeben.
@f{legendstyle} Erzeugt eine Legende für einen Datensatz (ohne Legendentext).
@f{legendtext} Gib den Legendentext eines Datensatzes aus.
@f{legend} Erzeugt eine Legende für 1D- und 2D-Datensätze.
@f{linkaxisscale} Die Funktion berechnet über die Funktion scale * x + offset die Skalierung der Achse, basierend auf der Achse die durch die Parameter diagramname und axis (x,y,z) angegeben ist.
@f{marker} Diese Funktion kann in den Achsentitel eines Diagramms eingefügt werden. Sie zeigt den Marker des ersten Datensatzes an.
@f{ncattfromdata} Gibt ein Attribut aus einer netCDF-Datei (NC-Datei) aus. Der Name der Datei wird dem angegebenen Datensatz entnommen.
@f{ncattribute} Gibt ein Attribut aus einer netCDF-Datei (NC-Datei) aus.
@f{ncvaluefromdata} Gibt einen Datenpunkt aus einer netCDF-Datei (NC-Datei) aus. Der Name des netCDF-Datei wird über den Datensatznamen ermittelt.
@f{pagename} Liefert den Seitennamen.
@f{pagenumber} Schreibt die Nummer der Seite.
@f{revnum} Zeigt die Versions-Nummer des Dokuments an.
@f{scaleaxis} Erzeugt eine Achsenskalierung in Abhängigkeit von einer anderen Achse eines Diagramms der Seite.
@f{summaryinfo} Gibt einen Text aus dem Dialogfeld Datei=>Info aus.
@f{symbol} Zeichen aus dem Symbolzeichensatz ausgeben.
@f{time} Schreibt die aktuelle Zeit.
@f{update3dcolorlegendtable} Farblegende für x/y/z-Datensätze. Die Feldfunktion muss in den Namen eines Tabellenobjekts eingetragen werden.
@f{update3dcolorlegend} Farblegende für x/y/z-Datensätze.
@f{xyZstatvalue} Schreibt eine statistische Kennzahl für den angegebenen 3D-Datensatz in ein Textobjekt oder eine Tabellenzelle.
@f{xyinterpol} Schreibt für eine gegebene x-Koordinate die interpolierten y-Koordinate oder für eine gegebene y-Koordinate die interpolierten x-Koordinate für den angegebenen 1D oder 2D Datensatz in das Textobjekt.
@f{xyminmax} Gibt die Koordinaten des Minimums und des Maximums eines Datensatzes aus.
@f{xystatistic} Gibt die Größen Minimum, Maximum, arith. Mittelwert, Mittlere Abweichung, Varianz und Standard-Abweichung für einen x/y-Datensatz aus.
@f{xystatvalue} Schreibt eine statistische Kennzahl für den angegebenen 1D oder 2D Datensatz in das Textobjekt.
@f{xyvalue} Schreibt eine x- oder y-Koordinate für den angegebenen 1D oder 2D Datensatz in das Textobjekt.
@f{xyzstatistic} Gibt statistische Kennzahlen für ein Kennfeld aus (siehe Beispiel).
@f{xyzvolume} Berechnet das Volumen, die Fläche oder den Quotienten Volumen/Fläche für ein Kennfeld.

Schreiben eigener Feldfunktionen

Es können eigene Feldfunktionen definiert werden. Das folgende Beispiel zeigt die Feldfunktion @f{pagename}. Der Name der Feldfunktion muss mit dem Prefix __ff_ beginnen (2 Unterstriche gefolgt von den Zeichen ff gefolgt von einem Unterstrich). Der Funktionname darf nur Kleinbuchstaben enthalten. Die Parameterliste der Funktion muss mit dem Beispiel übereinstimmen. Optionale Aufruf- Parameter werden in dem String-Vektor svParameter übergeben. Es können nur Zeichenketten übergeben werden. Die Funktion muss einen skalaren String zurückgeben. Im Fehlerfall soll die Funktion einen leeren String ("") zurückgeben.

Für die benutzerdefinierten Feldfunktionen sollte eine eigene IC-Datei erzeugt werden, die im Autoload-Verzeichnis (uniplot\autoload) gespeichert werden sollte. Die in diesem Verzeichnis gespeicherten IC-Dateien werden beim Start von UniPlot automatisch geladen.

Der Parameter hText enthält die Zugriffsnummer des Textobjektes, in dem sich die Feldfunktion befindet. Der Parameter hLayer enthält die Zugriffsnummer des Diagramms, in dem sich das Textobjekt hText befindet. Der Parameter hPage enthält die Zugriffsnummer der Seite und hDoc die Zugriffsnummer des Dokuments, in dem sich das Textobjekt befindet.

Der Parameter nAction wird z. Z. noch nicht verwendet.

Beispiel:

def __ff_pagename(hDoc, hPage, hLayer, hText, nAction, svParameter)
{
    if (hPage != 0) {
        return PageGetTitle(hPage);
    }
    return "";
}

Weiter Beispiele finden Sie im Verzeichnis uniplot\script\field.

id-1133232