Page History

Hidden

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE

HTML Table

class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#addCompoundPeriodChange(newPeriod, date) Adds a compound period change.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#addLoan(amount, firstDate, [lastDate], [period], [number], [startday]) Adds a loan.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#addPayment(amount, firstDate, [lastDate], [period], [number], [startday]) Adds a payment.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#addRateChange(newRate, date) Sets a new interest rate.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#calculateAmortizationSchedule() Calculates the amortization schedule.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSDataSet

Table Cell (td)
#getAmortizationSchedule() Gets the amortization schedule as a JSDataSet.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getError() Returns the error that remains when solving for the unknown.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSDataSet

Table Cell (td)
#getEvents() Returns all the amortization events - such as rate changes, loan events, payment events, compounding period changes.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getRestBalance() Gets the rest balance after the amortization schedule.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getUnknown() Returns the solveForUnknown value.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#isValidPeriod(period) Returns true if the period is valid, or false if the period is not valid.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#roundMoney(amount) Rounds a number up to the nearest cents.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#solveForUnknown() Returns true if successful or false if the call failed.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#sortEvents() Sorts the amortization events ascending by date.

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

Table Body (tbody)

id	addCompoundPeriodChange
class	node

Table Row (tr)

id	name

Table Cell (td)
addCompoundPeriodChange

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

addCompoundPeriodChange

Span

style	float: left;
id	iets

(newPeriod, date)

Table Row (tr)

id	des

Table Cell (td)
Adds a compound period change.

Table Row (tr)

id	prs

Table Cell (td)
Parameters newPeriod date

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var c = plugins.amortization.newCalculation();
c.addRateChange(r, new Date(2005, 0, 1));
c.addCompoundPeriodChange(12, new Date(2005, 0, 1));
c.addLoan(2000, new Date(2005, 0, 1));
c.addPayment(500, new Date(2005, 1, 28), null, 12, 5, 31);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addLoan
class	node

Table Row (tr)

id	name

Table Cell (td)
addLoan

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

addLoan

Span

style	float: left;
id	iets

(amount, firstDate, [lastDate], [period], [number], [startday])

Table Row (tr)

id	des

Table Cell (td)
Adds a loan.

Table Row (tr)

id	prs

Table Cell (td)
Parameters amount firstDate [lastDate] [period] [number] [startday]

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var c = plugins.amortization.newCalculation();
c.addRateChange(r, new Date(2005, 0, 1));
c.addCompoundPeriodChange(12, new Date(2005, 0, 1));
c.addLoan(2000, new Date(2005, 0, 1));
c.addPayment(500, new Date(2005, 1, 28), null, 12, 5, 31);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addPayment
class	node

Table Row (tr)

id	name

Table Cell (td)
addPayment

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

addPayment

Span

style	float: left;
id	iets

(amount, firstDate, [lastDate], [period], [number], [startday])

Table Row (tr)

id	des

Table Cell (td)
Adds a payment.

Table Row (tr)

id	prs

Table Cell (td)
Parameters amount firstDate [lastDate] [period] [number] [startday]

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var c = plugins.amortization.newCalculation();
c.addRateChange(r, new Date(2005, 0, 1));
c.addCompoundPeriodChange(12, new Date(2005, 0, 1));
c.addLoan(2000, new Date(2005, 0, 1));
c.addPayment(500, new Date(2005, 1, 28), null, 12, 5, 31);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addRateChange
class	node

Table Row (tr)

id	name

Table Cell (td)
addRateChange

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

addRateChange

Span

style	float: left;
id	iets

(newRate, date)

Table Row (tr)

id	des

Table Cell (td)
Sets a new interest rate.

Table Row (tr)

id	prs

Table Cell (td)
Parameters newRate date

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var c = plugins.amortization.newCalculation();
c.addRateChange(r, new Date(2005, 0, 1));
c.addCompoundPeriodChange(12, new Date(2005, 0, 1));
c.addLoan(2000, new Date(2005, 0, 1));
c.addPayment(500, new Date(2005, 1, 28), null, 12, 5, 31);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	calculateAmortizationSchedule
class	node

Table Row (tr)

id	name

Table Cell (td)
calculateAmortizationSchedule

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

calculateAmortizationSchedule

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Calculates the amortization schedule.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.amortization.calculateAmortizationSchedule();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getAmortizationSchedule
class	node

Table Row (tr)

id	name

Table Cell (td)
getAmortizationSchedule

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSDataSet

Span

style	float: left; font-weight: bold;
id	iets

getAmortizationSchedule

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Gets the amortization schedule as a JSDataSet.

Table Row (tr)

id	ret

Table Cell (td)
Returns JSDataSet

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.amortization.getAmortizationSchedule();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getError
class	node

Table Row (tr)

id	name

Table Cell (td)
getError

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getError

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns the error that remains when solving for the unknown. Please note that the error should be less or equal to 1E-8 - otherwise, the solveForUnknown value is incorrect.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//Returns the error that remains when solving for the unknown.
Please note that the error should be less or equal to 1E-8 - otherwise, the solveForUnknown value is incorrect.
var c = plugins.amortization.newCalculation();
// sets the rate to -1 for unknown.
c.addRateChange(-1, new Date(2005, 0, 1));
c.addCompoundPeriodChange(12, new Date(2005, 0, 1));
c.addLoan(2000, new Date(2005, 0, 1));
var lastDate = null;
var period = 12;
var number_count = 5;
var startday = 31;
c.addPayment(500, new Date(2005, 1, 28), lastDate, period,number_count, startday);
// solves for the interest rate.
c.solveForUnknown();
// gets the interest rate and the error in the calculation.
// which should be small (otherwise the calculation did
// not converge for some reason.
var r = c.getUnknown();
var e = c.getError();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getEvents
class	node

Table Row (tr)

id	name

Table Cell (td)
getEvents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSDataSet

Span

style	float: left; font-weight: bold;
id	iets

getEvents

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns all the amortization events - such as rate changes, loan events, payment events, compounding period changes.

Table Row (tr)

id	ret

Table Cell (td)
Returns JSDataSet

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.amortization.getEvents();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRestBalance
class	node

Table Row (tr)

id	name

Table Cell (td)
getRestBalance

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getRestBalance

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Gets the rest balance after the amortization schedule.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var rb = plugins.amortization.getRestBalance();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getUnknown
class	node

Table Row (tr)

id	name

Table Cell (td)
getUnknown

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getUnknown

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns the solveForUnknown value.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.amortization.getUnknown();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	isValidPeriod
class	node

Table Row (tr)

id	name

Table Cell (td)
isValidPeriod

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

isValidPeriod

Span

style	float: left;
id	iets

(period)

Table Row (tr)

id	des

Table Cell (td)
Returns true if the period is valid, or false if the period is not valid.

Table Row (tr)

id	prs

Table Cell (td)
Parameters period

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//Returns true if the period is valid, or false if the period is not valid.

var v_period = plugins.amortization.isValidPeriod(12);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	roundMoney
class	node

Table Row (tr)

id	name

Table Cell (td)
roundMoney

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

roundMoney

Span

style	float: left;
id	iets

(amount)

Table Row (tr)

id	des

Table Cell (td)
Rounds a number up to the nearest cents.

Table Row (tr)

id	prs

Table Cell (td)
Parameters amount

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//Rounds a number up to the nearest cents.

//rounds the number up to 34.35
var rm = plugins.amortization.roundMoney(34.349384);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	solveForUnknown
class	node

Table Row (tr)

id	name

Table Cell (td)
solveForUnknown

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

solveForUnknown

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns true if successful or false if the call failed.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//Returns true if successful or false if the call failed.

plugins.amortization.solveForUnknown();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	sortEvents
class	node

Table Row (tr)

id	name

Table Cell (td)
sortEvents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

sortEvents

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Sorts the amortization events ascending by date.

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//Sorts the amortization events ascending by date.

plugins.amortization.sortEvents();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 16

New Version Current

Key

addCompoundPeriodChange

addLoan

addPayment

addRateChange

calculateAmortizationSchedule

getAmortizationSchedule

getError

getEvents

getRestBalance

getUnknown

isValidPeriod

roundMoney

solveForUnknown

sortEvents