Föregående Nästa

Klass BirtMath

Klassen BirtMath innehåller funktioner för att ändra numeriska data, t.ex. för att addera, subtrahera, multiplicera, dividera och avrunda tal. Ett tal är ett generiskt objekt som kan omvandlas till en annan typ i fältet Datatyp i dialogrutan Redigera databindning. Klassen är statisk. Tillämpningen kan inte skapa förekomster av klassen.

BirtMath.add

Returnerar summan av två tal.

Syntax

Number BirtMath.add( Number n1, Number n2 )

Parametrar

n1

Talobjekt. Det första talet i beräkningen.

n2

Det andra talet i beräkningen.

Returnerar

Talobjekt. Det tal som blir resultatet av att addera n1 och n2.

Exempel

I följande exempel returneras summan av värden i fälten SalesTotal och Shipping:

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

BirtMath.ceiling

Avrundar ett tal uppåt, från 0, till närmast angiven multipel.

Syntax

Number BirtMath.ceiling( Number n, Number significance )

Parametrar

n

Talobjekt. Talet som ska avrundas uppåt.

significance

Talobjekt. Multipeln som n ska avrundas till.

Returnerar

Talobjekt. Resultatet av avrundningen. Om n är en exakt signifikansmultipel görs ingen avrundning.

Exempel

BirtMath.ceiling( ) används vanligen för avrundning av priser. Om du vill undvika penny kan du avrunda priser i ett prisfält till närmaste fem cent med följande uttryck:

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

Om priset är 20.52 returnerar uttrycket 20.55.

Följande uttryck avrundar priset uppåt till närmaste tio cent:

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

Om priset är 20.52 returnerar uttrycket 20.60. Om priset är 20.40 returnerar uttrycket 20.40. Ingen avrundning sker eftersom 20.40 är en multipel av 0.1.

Följande uttryck avrundar priset uppåt till närmaste dollar:

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

Om priset är 20.30 returnerar uttrycket 21.

BirtMath.divide

Returnerar resultatet av division av ett tal med ett annat.

Syntax

Number BirtMath.divide( Number dividend, Number divisor )

Parametrar

dividend

Talobjekt. Det tal som ska divideras.

divisor

Talobjekt. Det tal som talet ska divideras med.

Returnerar

Talobjekt. Resultatet av divisionen.

Exempel

Följande exempel visar resultatet av division:

BirtMath.divide( 10, 2 ) // returnerar 5
BirtMath.divide( 2, 10) // returnerar 0.2

Följande exempel returnerar resultatet av att dividera värdena i fältet Total med värdena i fältet Quantity:

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

BirtMath.mod

Returnerar återstoden efter en division.

Syntax

Number BirtMath.mod( Number number, Number divisor )

Parametrar

tal

Talobjekt. Det tal som ska divideras.

divisor

Talobjekt. Talet som det första talet divideras med. Det måste vara ett annat tal än noll.

Returnerar

Återstoden efter divisionen.

Exempel

Följande exempel visar resultaten som funktionen returnerar för specifika tal:

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

Följande exempel kontrollerar om talen i fältet Grade är udda eller jämna. När divisorn är 2 returnerar funktionen 0 för jämna tal och 1 för udda tal.

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

BirtMath.multiply

Returnerar resultatet av en multiplikation.

Syntax

Number BirtMath.multiply( Number n1, Number n2 )

Parametrar

n1

Talobjekt. Det första talet i beräkningen.

n2

Talobjekt. Det andra talet i beräkningen.

Returnerar

Talobjekt. Resultatet av multiplikationen av n1 och n2.

Exempel

Följande exempel returnerar resultatet av multiplikationen av värdena i fälten QuantityOrdered och PriceEach:

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

BirtMath.round

Avrundar ett tal till angivet antal siffror.

Syntax

Number BirtMath.round( Number number, Number dec )

Parametrar

tal

Talobjekt. Det tal som ska avrundas.

dec

Talobjekt. Antal decimaler. Om du utesluter argumentet förutsätts 0.

Returnerar

Talobjekt. Ett avrundat tal med angivet antal siffror.

Exempel

Följande exempel visar resultaten som funktionen returnerar för specifika tal:

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

I följande exempel avrundas värdena i fältet PriceEstimate till ett heltal:

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

BirtMath.roundDown

Avrundar ett tal nedåt till angivet antal siffror.

Syntax

Number BirtMath.roundDown( Number number, Number dec )

Parametrar

tal

Talobjekt. Det tal som ska avrundas.

dec

Talobjekt. Antal decimaler som talet ska avrundas till. Om du utesluter argumentet förutsätts 0.

Returnerar

Talobjekt. Avrundar ett tal nedåt med angivet antal siffror.

Exempel

Följande exempel visar resultaten som funktionen returnerar för specifika tal:

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

I följande exempel avrundas värdena i fältet PriceEstimate nedåt till ett heltal:

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

BirtMath.roundUp

Avrundar ett tal uppåt till angivet antal siffror.

Syntax

Number BirtMath.roundUp( Number number, Number dec )

Parametrar

tal

Talobjekt. Talet som ska avrundas uppåt.

dec

Talobjekt. Antal siffror som talet ska avrundas uppåt till. Om du utesluter argumentet förutsätts 0.

Returnerar

Talobjekt. Avrundar ett tal uppåt till angivet antal siffror.

Exempel

Följande exempel visar resultaten som funktionen returnerar för specifika tal:

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

I följande exempel avrundas värdena i fältet PriceEstimate för att returnera ett heltal:

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

BirtMath.safeDivide

Returnerar resultatet av en division av två tal utan att dividera med noll.

Syntax

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

Parametrar

dividend

Talobjekt. Det tal som ska divideras.

divisor

Talobjekt. Det tal som talet ska divideras med.

ifZero

Objekt. Värdet som ska returneras om divisorn är noll.

Returnerar

Talobjekt. Talobjekt. Resultatet av divisionen.

Exempel

Följande exempel visar resultaten som funktionen returnerar för specifika tal:

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

Följande exempel returnerar resultatet av att dividera värdena i fältet Revenue med värdena i fältet Volume. Om värdet i fältet Volume är 0 returnerar funktionen 0.

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

BirtMath.subtract

Returnerar resultatet av en subtraktion av ett tal med ett annat.

Syntax

Number BirtMath.subtract( Number n1, Number n2 )

Parametrar

n1

Talobjekt. Talet som n2 ska subtraheras ifrån.

n2

Talobjekt. Talet som ska subtraheras från n1.

Returnerar

Talobjekt. Resultatet av n1 minus n2.

Exempel

Följande exempel visar resultatet av subraktion av specifika tal:

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

Följande exempel returnerar resultatet av att subtrahera värdena i fältet Discount från värdena i fältet Total:

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

(c) Copyright Actuate Corporation 2013