Class google.gdata.finance.Gain

Object
   |
   +--google.gdata.finance.Gain

class google.gdata.finance.Gain

Total gain for the portfolio or position.
Defined in gdata.js

Field Detail

$moneyClass_

Object $moneyClass_

google.gdata.finance.Gain

google.gdata.finance.Gain(<Object> opt_params)

Constructs a total gain using an object parameter whose property names match the setter method to use for each property.

Parameters:
opt_params - Optional parameters, each of which is used as the sole parameter to the associated setter method: money.

addMoney

void addMoney(<google.gdata.Money|Object> money)

Adds a new monetary value of the total gain.

Parameters:
money - Monetary value of the total gain to add, or object to use as a parameter to the google.gdata.Money constructor.

getMoney

Array.<google.gdata.Money> getMoney()

Returns the monetary value of the total gain.

Returns:
Monetary value of the total gain.

setMoney

void setMoney(<Array.<google.gdata.Money>|Array.<Object>|undefined> money)

Sets the monetary value of the total gain.

Parameters:
money - Monetary value of the total gain, where each monetary value of the total gain is added using the addMoney() function, or undefined to clear the monetary value of the total gain.