上一頁 下一頁

BirtMath 類別

BirtMath 類別提供函數來操作數值資料,例如,對數字進行加、減、乘、除和四捨五入。數字是可以強制轉型為「編輯資料連結」對話框的「資料類型」欄位中的另一種類型的一般物件。這個類別是靜態的。 應用程式無法建立這個類別的實例。

BirtMath.add

這個函數會傳回兩個數字的總和。

語法

Number BirtMath.add( Number n1, Number n2 )

參數

n1

Number 物件。計算中使用的第一個數字。

n2

計算中使用的第二個數字。

傳回

Number 物件。加總 n1 與 n2 而得出的數字。

範例

下列範例傳回 StartTime 欄位值與 Shipping 欄位值的總和:

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

BirtMath.ceiling

這個函數會將數字進位(遠離 0)四捨五入成最近的指定倍數。

語法

Number BirtMath.ceiling( Number n, Number significance )

參數

n

Number 物件。要無條件進位的數字。

significance

Number 物件。將 n 四捨五入成的倍數。

傳回

Number 物件。從四捨五入得出的數字。如果 n 就是有效值的精確倍數,就不會進行四捨五入。

範例

BirtMath.ceiling( ) 通常用來無條件進位價格。例如,為了避免處理一分錢,您可以使用下列表示式,將 Price 欄位中的價格無條件進位成最接近的五分錢:

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

如果 Price 值為 20.52,表示式會傳回 20.55。

下列表示式是將價格無條件進位成最接近的一角:

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

如果 Price 值為 20.52,表示式會傳回 20.60。如果 Price 值為 20.40,表示式會傳回 20.40。由於 20.40 就是 0.1 的倍數,而不會進行四捨五入。

下列表示式是將價格無條件進位成最接近的一元:

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

如果 Price 值為 20.30,表示式會傳回 21。

BirtMath.divide

這個函數會傳回兩個數字相除的結果。

語法

Number BirtMath.divide( Number dividend, Number divisor )

參數

dividend

Number 物件。要作為被除數的數字。

divisor

Number 物件。要作為被除數之除數的數字。

傳回

Number 物件。被除數除以除數而得出的數字。

範例

下列範例顯示除以特定數字的結果:

BirtMath.divide( 10, 2 ) // 傳回 5
BirtMath.divide( 2, 10) // 傳回 0.2

下列範例傳回 Total 欄位值除以 Quantity 欄位值的結果:

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

BirtMath.mod

這個函數會傳回數字除以除數之後的餘數。

語法

Number BirtMath.mod( Number number, Number divisor )

參數

number

Number 物件。要作為被除數的數字。

divisor

Number 物件。要作為第一個數字之除數的數字。您必須指定非零的數字。

傳回

數字除以除數之後的餘數。

範例

下列範例顯示函數針對特定數字所傳回的結果:

BirtMath.mod( 10, 3 ) // 傳回 1
BirtMath.mod( 10, 5 ) // 傳回 0
BirtMath.mod( 10, 6 ) // 傳回 4

下列範例會檢查 Grade 欄位中的數字是奇數或偶數。當除數為 2 時,若為偶數,函數會傳回 0,若為奇數,則傳回 1。

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

BirtMath.multiply

這個函數會傳回兩個數字相乘的結果。

語法

Number BirtMath.multiply( Number n1, Number n2 )

參數

n1

Number 物件。計算中使用的第一個數字。

n2

Number 物件。計算中使用的第二個數字。

傳回

Number 物件。n1 乘以 n2 所得出的數字。

範例

下列範例傳回 QuantityOrdered 與 PriceEach 欄位中的值相乘的結果:

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

BirtMath.round

這個函數會將數字四捨五入成指定的位數。

語法

Number BirtMath.round( Number number, Number dec )

參數

number

Number 物件。要四捨五入的數字。

dec

Number 物件。要將數字四捨五入成的位數。如果您省略這個引數,函數會假設 0。

傳回

Number 物件。四捨五入成指定位數的數字。

範例

下列範例顯示函數針對特定數字所傳回的結果:

BirtMath.round( 1545.50 ) // 傳回 1546
BirtMath.round( 1545.56, 1 ) // 傳回 1545.6
BirtMath.round( 1545.23, 1 ) // 傳回 1545.2
BirtMath.round( 1545.50, -1 ) // 傳回 1550

下列範例是四捨五入 PriceEstimate 欄位中的值,而傳回整數:

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

BirtMath.roundDown

這個函數會將數字無條件捨去成指定的位數。

語法

Number BirtMath.roundDown( Number number, Number dec )

參數

number

Number 物件。要四捨五入的數字。

dec

Number 物件。要將數字無條件捨去成的位數。如果您省略這個引數,函數會假設 0。

傳回

Number 物件。無條件捨去成指定位數的數字。

範例

下列範例顯示函數針對特定數字所傳回的結果:

BirtMath.roundDown( 1545.50 ) // 傳回 1545
BirtMath.roundDown( 1545.56, 1 ) // 傳回 1545.5
BirtMath.roundDown( 1545.23, 1 ) // 傳回 1545.2
BirtMath.roundDown( 1545.50, -1 ) // 傳回 1540

下列範例是四捨五入 PriceEstimate 欄位中的值,而傳回整數:

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

BirtMath.roundUp

這個函數會將數字無條件進位成指定的位數。

語法

Number BirtMath.roundUp( Number number, Number dec )

參數

number

Number 物件。要無條件進位的數字。

dec

Number 物件。要將數字四捨五入成的位數。如果您省略這個引數,函數會假設 0。

傳回

Number 物件。無條件進位成指定位數的數字。

範例

下列範例顯示函數針對特定數字所傳回的結果:

BirtMath.roundUp( 1545.50 ) // 傳回 1546
BirtMath.roundUp( 1545.56, 1 ) // 傳回 1545.6
BirtMath.roundUp( 1545.23, 1 ) // 傳回 1545.3
BirtMath.roundUp( 1545.50, -1 ) // 傳回 1550

下列範例是四捨五入 PriceEstimate 欄位中的值,而傳回整數:

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

BirtMath.safeDivide

這個函數會傳回兩個數字相除的結果,並且避免出現除以零的狀況。

語法

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

參數

dividend

Number 物件。要作為被除數的數字。

divisor

Number 物件。要作為被除數之除數的數字。

ifZero

Object。當除數為零時,要傳回的值。

傳回

Number 物件。Number 物件。被除數除以除數而得出的數字。

範例

下列範例顯示函數針對特定數字所傳回的結果:

BirtMath.safeDivide( 10, 2, 0 ) // 傳回 5
BirtMath.safeDivide( 10, 0, 0 ) // 傳回 0

下列範例傳回 Revenue 欄位值除以 Volume 欄位值的結果。如果 Volume 值為 0,函數會傳回 0。

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

BirtMath.subtract

這個函數會傳回兩個數字相減的結果。

語法

Number BirtMath.subtract( Number n1, Number n2 )

參數

n1

Number 物件。要從中扣除的數字。

n2

Number 物件。要從 n1 中扣除的數字。

傳回

Number 物件。從 n1 扣除 n2 而得出的數字。

範例

下列範例顯示扣除特定數字的結果:

BirtMath.subtract( 12, 4 ) // 傳回 8
BirtMath.subtract( 4, 12) // 傳回 -8

下列範例傳回 Total 欄位值減去 Discount 欄位值的結果:

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

© Copyright Actuate Corporation 2013