Vorheriges Nächstes

Klasse "BirtMath"

Die Klasse 'BirtMath' stellt Funktionen für die Bearbeitung numerischer Daten bereit, um beispielsweise Zahlen zu addieren, zu subtrahieren, zu multiplizieren, zu dividieren oder auf-/abzurunden. Eine Zahl (Number) ist ein generisches Objekt, das als anderer Typ im Feld 'Datentyp' des Dialogs 'Datenbinding bearbeiten' umgesetzt werden kann. Diese Klasse ist statisch. Die Anwendung kann keine Instanzen der Klasse erstellen.

BirtMath.add

Diese Funktion gibt die Summe von zwei Zahlen zurück.

Syntax

Number BirtMath.add( Number z1, Number z2 )

Parameter

z1

Zahlenobjekt (Number). Die erste Zahl, die in der Berechnung verwendet werden soll.

z2

Die zweite Zahl, die in der Berechnung verwendet werden soll.

Rückgabe

Zahlenobjekt (Number). Die Zahl, die sich aus der Addition von 'z1' und 'z2' ergibt.

Beispiel

Das folgende Beispiel gibt die Summe der Werte in den Feldern 'SalesTotal' und 'Shipping' zurück:

BirtMath.add( row["SalesTotal"], row["Shipping"] )

BirtMath.ceiling

Dies Funktion rundet eine Zahl von Null auf das nächste angegebene Vielfache auf.

Syntax

Number BirtMath.ceiling( Number z, Number signifikanz )

Parameter

z

Zahlenobjekt (Number). Die Zahl, die aufgerundet werden soll.

signifikanz

Zahlenobjekt (Number). Das Vielfache, auf das 'z' aufgerundet werden soll.

Rückgabe

Zahlenobjekt (Number). Eine Zahl, die sich aus der Rundung ergibt. Wenn 'z' ein genaues Vielfaches der Signifikanz ist, erfolgt keine Rundung.

Beispiele

BirtMath.ceiling( ) wird häufig zum Aufrunden von Preisen verwendet. Um je nach verwendeter Währung den Umgang mit einzelnen Penny- oder Cent-Münzen zu vermeiden, können Sie die Preise in einem Preisfeld mit dem folgenden Ausdruck bis zur nächsten 5-Penny- bzw. 5-Cent-Grenze aufrunden:

BirtMath.ceiling( row["Price"] , 0.05 )

Wenn der Wert für den Preis eigentlich "20.52" beträgt, gibt der Ausdruck den Wert "20.55" zurück.

Der folgende Ausdruck rundet Preise bis zur nächsten Zehn-Penny-Grenze (bzw. Zehn-Cent-Grenze) auf:

BirtMath.ceiling( row["Price"] , 0.1 )

Wenn der Wert für den Preis eigentlich "20.52" beträgt, gibt der Ausdruck den Wert "20.60" zurück. Wenn der Wert für den Preis '20.40' beträgt, gibt der Ausdruck '20.40' zurück. Es erfolgt keine Rundung, da '20.40' ein Vielfaches von '0.1' ist.

Der folgende Ausdruck rundet Preise bis zur nächsten Dollar-Grenze (bzw. Euro-Grenze) auf:

BirtMath.ceiling( row["Price"] , 1 )

Wenn der Wert für den Preis eigentlich "20.30" beträgt, gibt der Ausdruck den Wert "21" zurück.

BirtMath.divide

Diese Funktion gibt das Ergebnis der Division einer Zahl durch eine andere zurück.

Syntax

Number BirtMath.divide( Number dividend, Number divisor )

Parameter

dividend

Zahlenobjekt (Number). Die Zahl, die dividiert werden soll.

divisor

Zahlenobjekt (Number). Die Zahl, durch die der Dividend (also die zu dividierende Zahl) geteilt wird.

Rückgabe

Zahlenobjekt (Number). Eine Zahl, die sich aus der Division des Dividenden durch den Divisor ergibt.

Beispiele

Das folgende Beispiel zeigt, welche Ergebnisse bei der Division bestimmter Zahlen erzielt werden:

BirtMath.divide( 10, 2 ) // Rückgabewert: 5
BirtMath.divide( 2, 10) // Rückgabewert: 0.2

Das folgende Beispiel gibt das Ergebnis der Division von Werten im Feld 'Total' durch Werte im Feld 'Quantity' zurück:

BirtMath.divide( row["Total"], row["Quantity"] )

BirtMath.mod

Diese Funktion gibt den Restwert zurück, der nach der Division eines Werts durch einen Divisor (Teiler) übrigbleibt.

Syntax

Number BirtMath.mod( Number zahl, Number divisor )

Parameter

zahl

Zahlenobjekt (Number). Die Zahl, die dividiert werden soll.

divisor

Zahlenobjekt (Number). Die Zahl, durch die die erste Zahl geteilt wird. Es muss eine Zahl mit einem Wert ungleich null angegeben werden.

Rückgabe

Der Restwert, der nach der Division der Zahl durch den Divisor (Teiler) übrigbleibt.

Beispiele

Die folgenden Beispiele zeigen, welche Ergebnisse die Funktion für bestimmte Zahlen zurückgibt:

BirtMath.mod( 10, 3 ) // Rückgabewert: 1
BirtMath.mod( 10, 5 ) // Rückgabewert: 0
BirtMath.mod( 10, 6 ) // Rückgabewert: 4

Das folgende Beispiel prüft, ob die Zahlen im Feld "Grade" gerade oder ungerade sind. Wenn der Divisor '2' ist, gibt die Funktion bei geraden Zahlen den Wert '0' und bei ungeraden Zahlen den Wert '1' zurück.

BirtMath.mod( row["Grade"], 2 )

BirtMath.multiply

Diese Funktion gibt das Produkt von zwei Nummern zurück.

Syntax

Number BirtMath.multiply( Number n1, Number n2 )

Parameter

n1

Zahlenobjekt (Number). Die erste Zahl, die in der Berechnung verwendet werden soll.

n2

Zahlenobjekt (Number). Die zweite Zahl, die in der Berechnung verwendet werden soll.

Rückgabe

Zahlenobjekt (Number). Die Zahl, die sich aus der Multiplikation von 'z1' mit 'z2' ergibt.

Beispiel

Das folgende Beispiel gibt das Produkt aus den Werten in den Feldern 'QuantityOrdered' und 'PriceEach' zurück:

BirtMath.multiply( row["QuantityOrdered"], row["PriceEach"] )

BirtMath.round

Diese Funktion rundet eine Zahl auf eine angegebene Anzahl von Zahlen.

Syntax

Number BirtMath.round( Number number, Number dec )

Parameter

zahl

Zahlenobjekt (Number). Die Zahl, die gerundet werden soll.

dez

Zahlenobjekt (Number). Die Anzahl der Dezimalstellen, auf die die Zahl gerundet werden soll. Wenn Sie dieses Argument nicht verwenden, so setzt die Funktion die Verwendung des Wertes '0' voraus.

Rückgabe

Zahlenobjekt (Number). Eine Zahl, die auf eine bestimmte Anzahl von Dezimalstellen gerundet ist.

Beispiele

Die folgenden Beispiele zeigen, welche Ergebnisse die Funktion für bestimmte Zahlen zurückgibt:

BirtMath.round( 1545.50 ) // Rückgabewert: 1546
BirtMath.round( 1545.56, 1 ) // Rückgabewert: 1545.6
BirtMath.round( 1545.23, 1 ) // Rückgabewert: 1545.2
BirtMath.round( 1545.50, -1 ) // Rückgabewert: 1550

Das folgende Beispiel rundet die Werte im Feld 'PriceEstimate' so, dass eine Ganzzahl zurückgegeben wird:

BirtMath.round( row["PriceEstimate"], 0 )

BirtMath.roundDown

Diese Funktion rundet eine Zahl auf eine angegebene Anzahl von Zahlen ab.

Syntax

Number BirtMath.roundDown( Number number, Number dec )

Parameter

zahl

Zahlenobjekt (Number). Die Zahl, die gerundet werden soll.

dez

Zahlenobjekt (Number). Die Anzahl der Dezimalstellen, auf die die Zahl abgerundet werden soll. Wenn Sie dieses Argument nicht verwenden, so setzt die Funktion die Verwendung des Wertes '0' voraus.

Rückgabe

Zahlenobjekt (Number). Eine Zahl, die auf eine bestimmte Anzahl von Dezimalstellen abgerundet ist.

Beispiele

Die folgenden Beispiele zeigen, welche Ergebnisse die Funktion für bestimmte Zahlen zurückgibt:

BirtMath.roundDown( 1545.50 ) // Rückgabewert: 1545
BirtMath.roundDown( 1545.56, 1 ) // Rückgabewert: 1545.5
BirtMath.roundDown( 1545.23, 1 ) // Rückgabewert: 1545.2
BirtMath.roundDown( 1545.50, -1 ) // Rückgabewert: 1540

Das folgende Beispiel rundet die Werte im Feld 'PriceEstimate' so ab, dass eine Ganzzahl zurückgegeben wird:

BirtMath.roundDown( row["PriceEstimate"], 0 )

BirtMath.roundUp

Diese Funktion rundet eine Zahl auf eine angegebene Anzahl von Zahlen auf.

Syntax

Number BirtMath.roundUp( Number number, Number dec )

Parameter

zahl

Zahlenobjekt (Number). Die Zahl, die aufgerundet werden soll.

dez

Zahlenobjekt (Number). Die Anzahl der Dezimalstellen, auf die die Zahl aufgerundet werden soll. Wenn Sie dieses Argument nicht verwenden, so setzt die Funktion die Verwendung des Wertes '0' voraus.

Rückgabe

Zahlenobjekt (Number). Eine Zahl, die auf eine bestimmte Anzahl von Dezimalstellen aufgerundet ist.

Beispiele

Die folgenden Beispiele zeigen, welche Ergebnisse die Funktion für bestimmte Zahlen zurückgibt:

BirtMath.roundUp( 1545.50 ) // Rückgabewert: 1546
BirtMath.roundUp( 1545.56, 1 ) // Rückgabewert: 1545.6
BirtMath.roundUp( 1545.23, 1 ) // Rückgabewert: 1545.3
BirtMath.roundUp( 1545.50, -1 ) // Rückgabewert: 1550

Das folgende Beispiel rundet die Werte im Feld 'PriceEstimate' so auf, dass eine Ganzzahl zurückgegeben wird:

BirtMath.roundUp( row["PriceEstimate"], 0 )

BirtMath.safeDivide

Diese Funktion gibt das Ergebnis der Division einer Zahl durch eine andere zurück, wobei eine Division durch 0 verhindert wird.

Syntax

Number BirtMath.safeDivide( Number dividend, Number divisor, object ifZero )

Parameter

dividend

Zahlenobjekt (Number). Die Zahl, die dividiert werden soll.

divisor

Zahlenobjekt (Number). Die Zahl, durch die der Dividend (also die zu dividierende Zahl) geteilt wird.

ifZero

Objekt. Der Wert, der zurückgegeben werden soll, wenn der Divisor 0 ist.

Rückgabe

Zahlenobjekt (Number). Zahlenobjekt. Eine Zahl, die sich aus der Division des Dividenden durch den Divisor ergibt.

Beispiele

Die folgenden Beispiele zeigen, welche Ergebnisse die Funktion für bestimmte Zahlen zurückgibt:

BirtMath.safeDivide( 10, 2, 0 ) // Rückgabewert: 5
BirtMath.safeDivide( 10, 0, 0 ) // Rückgabewert: 0

Das folgende Beispiel gibt das Ergebnis der Division von Werten im Feld 'Revenue' durch Werte im Feld 'Volume' zurück. Wenn 'Volume' den Wert 0 hat, gibt die Funktion den Wert 0 zurück.

BirtMath.safeDivide( row["Revenue"], row["Volume"], 0 )

BirtMath.subtract

Diese Funktion gibt das Ergebnis der Subtraktion einer Zahl von einer anderen zurück.

Syntax

Number BirtMath.subtract( Number n1, Number n2 )

Parameter

n1

Zahlenobjekt (Number). Die Zahl, von der die andere Zahl subtrahiert werden soll.

n2

Zahlenobjekt (Number). Die Zahl, die von 'n1' subtrahiert werden soll.

Rückgabe

Zahlenobjekt (Number). Eine Zahl, die sich aus der Subtraktion der Zahl 'n2' von der Zahl 'n1' ergibt.

Beispiel

Das folgende Beispiel zeigt, welche Ergebnisse bei der Subtraktion bestimmter Zahlen erzielt werden:

BirtMath.subtract( 12, 4 ) // Rückgabewert: 8
BirtMath.subtract( 4, 12) // Rückgabewert: -8

Das folgende Beispiel gibt das Ergebnis der Subtraktion von Werten im Feld 'Discount' von Werten im Feld 'Total' zurück:

BirtMath.subtract( row["Total"], row["Discount"] )

(c) Copyright Actuate Corporation 2013