|
GData JavaScript Client 2.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--google.gdata.finance.PortfolioData
Data for the portfolio.
Defined in gdata.js
Field Summary | |
Object |
$costBasisClass_
|
Object |
$daysGainClass_
|
Object |
$gainClass_
|
Object |
$marketValueClass_
|
{string|undefined} |
currencyCode
ISO4217 currency code. |
{string|undefined} |
gainPercentage
Percentage gain. |
{string|undefined} |
return1w
1 week return (percentage). |
{string|undefined} |
return1y
1 year return (percentage). |
{string|undefined} |
return3m
3 month return (percentage). |
{string|undefined} |
return3y
3 year return (percentage). |
{string|undefined} |
return4w
4 week return (percentage). |
{string|undefined} |
return5y
5 year return (percentage). |
{string|undefined} |
returnOverall
Overall return (percentage). |
{string|undefined} |
returnYTD
Year-to-date return (percentage). |
Constructor Summary | |
google.gdata.finance.PortfolioData(<Object> opt_params)
Constructs a portfolio data using an object parameter whose property names match the setter method to use for each property. |
Method Summary | |
google.gdata.finance.CostBasis|undefined
|
getCostBasis()
Returns the cost basis of the portfolio in the portfolio default currency. |
string|undefined
|
getCurrencyCode()
Returns the ISO4217 currency code. |
google.gdata.finance.DaysGain|undefined
|
getDaysGain()
Returns the today's gain for the portfolio in the portfolio default currency. |
google.gdata.finance.Gain|undefined
|
getGain()
Returns the gain for the portfolio in the portfolio default currency. |
number|undefined
|
getGainPercentage()
Returns the percentage gain. |
google.gdata.finance.MarketValue|undefined
|
getMarketValue()
Returns the market value of the portfolio in the portfolio default currency. |
number|undefined
|
getReturn1w()
Returns the 1 week return (percentage). |
number|undefined
|
getReturn1y()
Returns the 1 year return (percentage). |
number|undefined
|
getReturn3m()
Returns the 3 month return (percentage). |
number|undefined
|
getReturn3y()
Returns the 3 year return (percentage). |
number|undefined
|
getReturn4w()
Returns the 4 week return (percentage). |
number|undefined
|
getReturn5y()
Returns the 5 year return (percentage). |
number|undefined
|
getReturnOverall()
Returns the overall return (percentage). |
number|undefined
|
getReturnYTD()
Returns the Year-to-date return (percentage). |
void
|
setCostBasis(<google.gdata.finance.CostBasis|Object|undefined> costBasis)
Sets the cost basis of the portfolio in the portfolio default currency. |
void
|
setCurrencyCode(<string|undefined> currencyCode)
Sets the ISO4217 currency code. |
void
|
setDaysGain(<google.gdata.finance.DaysGain|Object|undefined> daysGain)
Sets the today's gain for the portfolio in the portfolio default currency. |
void
|
setGain(<google.gdata.finance.Gain|Object|undefined> gain)
Sets the gain for the portfolio in the portfolio default currency. |
void
|
setGainPercentage(<number|undefined> gainPercentage)
Sets the percentage gain. |
void
|
setMarketValue(<google.gdata.finance.MarketValue|Object|undefined> marketValue)
Sets the market value of the portfolio in the portfolio default currency. |
void
|
setReturn1w(<number|undefined> return1w)
Sets the 1 week return (percentage). |
void
|
setReturn1y(<number|undefined> return1y)
Sets the 1 year return (percentage). |
void
|
setReturn3m(<number|undefined> return3m)
Sets the 3 month return (percentage). |
void
|
setReturn3y(<number|undefined> return3y)
Sets the 3 year return (percentage). |
void
|
setReturn4w(<number|undefined> return4w)
Sets the 4 week return (percentage). |
void
|
setReturn5y(<number|undefined> return5y)
Sets the 5 year return (percentage). |
void
|
setReturnOverall(<number|undefined> returnOverall)
Sets the overall return (percentage). |
void
|
setReturnYTD(<number|undefined> returnYTD)
Sets the Year-to-date return (percentage). |
Field Detail |
Object $costBasisClass_
Object $daysGainClass_
Object $gainClass_
Object $marketValueClass_
{string|undefined} currencyCode
{string|undefined} gainPercentage
{string|undefined} return1w
{string|undefined} return1y
{string|undefined} return3m
{string|undefined} return3y
{string|undefined} return4w
{string|undefined} return5y
{string|undefined} returnOverall
{string|undefined} returnYTD
Constructor Detail |
google.gdata.finance.PortfolioData(<Object> opt_params)
opt_params
- Optional parameters, each of which is used as the sole parameter to the associated setter method: costBasis, currencyCode, daysGain, gain, gainPercentage, marketValue, return1w, return1y, return3m, return3y, return4w, return5y, returnOverall, and returnYTD.
Method Detail |
google.gdata.finance.CostBasis|undefined getCostBasis()
string|undefined getCurrencyCode()
google.gdata.finance.DaysGain|undefined getDaysGain()
google.gdata.finance.Gain|undefined getGain()
number|undefined getGainPercentage()
google.gdata.finance.MarketValue|undefined getMarketValue()
number|undefined getReturn1w()
number|undefined getReturn1y()
number|undefined getReturn3m()
number|undefined getReturn3y()
number|undefined getReturn4w()
number|undefined getReturn5y()
number|undefined getReturnOverall()
number|undefined getReturnYTD()
void setCostBasis(<google.gdata.finance.CostBasis|Object|undefined> costBasis)
costBasis
- Cost basis of the portfolio in the portfolio default currency, or object to use as a parameter to the google.gdata.finance.CostBasis constructor, or undefined for none.
void setCurrencyCode(<string|undefined> currencyCode)
currencyCode
- ISO4217 currency code or undefined for none.
void setDaysGain(<google.gdata.finance.DaysGain|Object|undefined> daysGain)
daysGain
- Today's gain for the portfolio in the portfolio default currency, or object to use as a parameter to the google.gdata.finance.DaysGain constructor, or undefined for none.
void setGain(<google.gdata.finance.Gain|Object|undefined> gain)
gain
- Gain for the portfolio in the portfolio default currency, or object to use as a parameter to the google.gdata.finance.Gain constructor, or undefined for none.
void setGainPercentage(<number|undefined> gainPercentage)
gainPercentage
- Percentage gain or undefined for none.
void setMarketValue(<google.gdata.finance.MarketValue|Object|undefined> marketValue)
marketValue
- Market value of the portfolio in the portfolio default currency, or object to use as a parameter to the google.gdata.finance.MarketValue constructor, or undefined for none.
void setReturn1w(<number|undefined> return1w)
return1w
- 1 week return (percentage) or undefined for none.
void setReturn1y(<number|undefined> return1y)
return1y
- 1 year return (percentage) or undefined for none.
void setReturn3m(<number|undefined> return3m)
return3m
- 3 month return (percentage) or undefined for none.
void setReturn3y(<number|undefined> return3y)
return3y
- 3 year return (percentage) or undefined for none.
void setReturn4w(<number|undefined> return4w)
return4w
- 4 week return (percentage) or undefined for none.
void setReturn5y(<number|undefined> return5y)
return5y
- 5 year return (percentage) or undefined for none.
void setReturnOverall(<number|undefined> returnOverall)
returnOverall
- Overall return (percentage) or undefined for none.
void setReturnYTD(<number|undefined> returnYTD)
returnYTD
- Year-to-date return (percentage) or undefined for none.
|
GData JavaScript Client 2.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |