Forrige Næste

Klassen BirtMath

Klassen BirtMath indeholder funktioner til bearbejdning af numeriske data, f.eks. addition, subtraktion, multiplikation, division og afrunding af tal. Et tal er et generisk objekt, der kan konverteres til en anden type i feltet Datatype i dialogboksen Redigér databinding. Klassen er statisk. Programmet kan ikke oprette forekomster af klassen.

BirtMath.add

Funktionen returnerer summen af to tal.

Syntaks

Number BirtMath.add( Number n1, Number n2 )

Parametre

n1

Talobjekt. Det første tal, der skal bruges i beregningen.

n2

Det andet tal, der skal bruges i beregningen.

Returnerer

Talobjekt. Det tal, der er resultatet af, at n1 og n2 lægges sammen.

Eksempel

Følgende eksempel returnerer summen af værdier i felterne SalesTotal og Shipping:

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

BirtMath.ceiling

Funktionen runder et tal op (væk fra nul) til det nærmeste angivne multiplum.

Syntaks

Number BirtMath.ceiling( Number n, Number significance )

Parametre

n

Talobjekt. Det tal, der skal rundes op.

significance

Talobjekt. Det multiplum, som n skal afrundes til.

Returnerer

Talobjekt. Et tal, der er resultatet af afrundingen. Hvis n er et nøjagtigt multiplum af significance, foretages ingen afrunding.

Eksempler

BirtMath.ceiling( ) bruges ofte til at runde priser op. Eksempel: For at undgå at håndtere 1 cent-mønter kan priser i et prisfelt rundes op til nærmeste 5 cent-mønt med følgende udtryk:

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

Hvis prisen er 20,52, returnerer udtrykket 20,55.

Følgende udtryk runder priser op til nærmeste 10 cent-mønt:

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

Hvis prisen er 20,52, returnerer udtrykket 20,60. Hvis prisen er 20.40, returnerer udtrykket 20.40. Der sker ingen afrunding, fordi 20,40 er et multiplum af 0,1.

Følgende udtryk runder priser op til nærmeste dollar:

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

Hvis prisen er 20,30, returnerer udtrykket 21.

BirtMath.divide

Funktionen returnerer resultatet af, at et tal divideres med et andet.

Syntaks

Number BirtMath.divide( Number dividend, Number divisor )

Parametre

dividend

Talobjekt. Det tal, der skal divideres.

divisor

Talobjekt. Det tal, som dividenden skal divideres med.

Returnerer

Talobjekt. Et tal, der er resultatet af, at dividend divideres med divisor.

Eksempler

Følgende eksempel viser resultatet af to tal, der divideres med hinanden:

BirtMath.divide( 10, 2 ) // returnerer 5
BirtMath.divide( 2, 10) // returnerer 0,2

Følgende eksempel returnerer resultatet af, at værdier i feltet Total divideres med værdier i feltet Quantity:

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

BirtMath.mod

Funktionen returnerer den rest, der fremkommer, når et tal er divideret med en divisor.

Syntaks

Number BirtMath.mod( Number number, Number divisor )

Parametre

number

Talobjekt. Det tal, der skal divideres.

divisor

Talobjekt. Det tal, som det første tal skal divideres med. Du skal angive et tal, der er forskelligt fra nul.

Returnerer

Resten, når et tal er divideret med divisor.

Eksempler

Følgende eksempler viser de resultater, som funktionen returnerer for bestemte tal:

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

Følgende eksempel kontrollerer, om tal i feltet Grade er lige eller ulige. Når divisoren er 2, returnerer funktionen 0 for lige tal og 1 for ulige tal.

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

BirtMath.multiply

Funktionen returnerer resultatet af to tal, der ganges med hinanden.

Syntaks

Number BirtMath.multiply( Number n1, Number n2 )

Parametre

n1

Talobjekt. Det første tal, der skal bruges i beregningen.

n2

Talobjekt. Det andet tal, der skal bruges i beregningen.

Returnerer

Talobjekt. Et tal, der er resultatet af, at n1 og n2 multipliceres.

Eksempel

Følgende eksempel returnerer resultatet af, at værdier i felterne QuantityOrdered og PriceEach multipliceres:

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

BirtMath.round

Funktionen afrunder et tal til et angivet antal cifre.

Syntaks

Number BirtMath.round( Number number, Number dec )

Parametre

number

Talobjekt. Det tal, der skal afrundes.

dec

Talobjekt. Det antal cifre, tallet skal afrundes til. Hvis du udelader argumentet, bruges værdien 0 af funktionen.

Returnerer

Talobjekt. Et tal, der er afrundet til et angivet antal cifre.

Eksempler

Følgende eksempler viser de resultater, som funktionen returnerer for bestemte tal:

BirtMath.round( 1545.50 ) // returnerer 1546
BirtMath.round( 1545.56, 1 ) // returnerer 1545,6
BirtMath.round( 1545.23, 1 ) // returnerer 1545,2
BirtMath.round( 1545.50, -1 ) // returnerer 1550

Følgende eksempel afrunder værdierne i feltet PriceEstimate til et heltal:

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

BirtMath.roundDown

Funktionen runder et tal ned til et angivet antal cifre.

Syntaks

Number BirtMath.roundDown( Number number, Number dec )

Parametre

number

Talobjekt. Det tal, der skal afrundes.

dec

Talobjekt. Det antal cifre, tallet skal rundes ned til. Hvis du udelader argumentet, bruges værdien 0 af funktionen.

Returnerer

Talobjekt. Et tal, der er rundet ned til et angivet antal cifre.

Eksempler

Følgende eksempler viser de resultater, som funktionen returnerer for bestemte tal:

BirtMath.roundDown( 1545.50 ) // returnerer 1545
BirtMath.roundDown( 1545.56, 1 ) // returnerer 1545,5
BirtMath.roundDown( 1545.23, 1 ) // returnerer 1545,2
BirtMath.roundDown( 1545.50, -1 ) // returnerer 1540

Følgende eksempel runder værdierne i feltet PriceEstimate ned til et heltal:

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

BirtMath.roundUp

Funktionen runder et tal op til et angivet antal cifre.

Syntaks

Number BirtMath.roundUp( Number number, Number dec )

Parametre

number

Talobjekt. Det tal, der skal rundes op.

dec

Talobjekt. Det antal cifre, tallet skal rundes op til. Hvis du udelader argumentet, bruges værdien 0 af funktionen.

Returnerer

Talobjekt. Et tal, der er rundet op til et angivet antal cifre.

Eksempler

Følgende eksempler viser de resultater, som funktionen returnerer for bestemte tal:

BirtMath.roundUp( 1545.50 ) // returnerer 1546
BirtMath.roundUp( 1545.56, 1 ) // returnerer 1545,6
BirtMath.roundUp( 1545.23, 1 ) // returnerer 1545,3
BirtMath.roundUp( 1545.50, -1 ) // returnerer 1550

Følgende eksempel runder værdierne i feltet PriceEstimate op til et heltal:

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

BirtMath.safeDivide

Funktionen returnerer resultatet af, at et tal divideres med et andet og undgår division med nul.

Syntaks

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

Parametre

dividend

Talobjekt. Det tal, der skal divideres.

divisor

Talobjekt. Det tal, som dividenden skal divideres med.

ifZero

Object. Den værdi, der skal returneres, hvis divisoren er nul.

Returnerer

Talobjekt. Et tal, der er resultatet af, at dividend divideres med divisor.

Eksempler

Følgende eksempler viser de resultater, som funktionen returnerer for bestemte tal:

BirtMath.safeDivide( 10, 2, 0 ) // returnerer 5
BirtMath.safeDivide( 10, 0, 0 ) // returnerer 0

Følgende eksempel returnerer resultatet af, at værdier i feltet Revenue divideres med værdier i feltet Volume. Hvis værdien i Volume er 0, returnerer funktionen 0.

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

BirtMath.subtract

Funktionen returnerer resultatet af, at et tal trækkes fra et andet.

Syntaks

Number BirtMath.subtract( Number n1, Number n2 )

Parametre

n1

Talobjekt. Det tal, et andet tal skal trækkes fra.

n2

Talobjekt. Det tal, der skal trækkes fra n1.

Returnerer

Talobjekt. Et tal, der er resultatet af, at n2 trækkes fra n1.

Eksempel

Følgende eksempel viser resultatet af, at bestemte tal trækkes fra hinanden:

BirtMath.subtract( 12, 4 ) // returnerer 8
BirtMath.subtract( 4, 12) // returnerer -8

Følgende eksempel returnerer resultatet af, at værdier i feltet Discount trækkes fra værdier i feltet Total:

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

(c) Copyright Actuate Corporation 2013