Class google.gdata.finance.PortfolioData

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

class google.gdata.finance.PortfolioData

Data for the portfolio.
Defined in gdata.js

Field Detail

$costBasisClass_

Object $costBasisClass_

$daysGainClass_

Object $daysGainClass_

$gainClass_

Object $gainClass_

$marketValueClass_

Object $marketValueClass_

currencyCode

{string|undefined} currencyCode

ISO4217 currency code. This attribute is optional.

gainPercentage

{string|undefined} gainPercentage

Percentage gain. This attribute is optional.

return1w

{string|undefined} return1w

1 week return (percentage). This attribute is optional.

return1y

{string|undefined} return1y

1 year return (percentage). This attribute is optional.

return3m

{string|undefined} return3m

3 month return (percentage). This attribute is optional.

return3y

{string|undefined} return3y

3 year return (percentage). This attribute is optional.

return4w

{string|undefined} return4w

4 week return (percentage). This attribute is optional.

return5y

{string|undefined} return5y

5 year return (percentage). This attribute is optional.

returnOverall

{string|undefined} returnOverall

Overall return (percentage). This attribute is optional.

returnYTD

{string|undefined} returnYTD

Year-to-date return (percentage). This attribute is optional.

google.gdata.finance.PortfolioData

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.

Parameters:
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.

getCostBasis

google.gdata.finance.CostBasis|undefined getCostBasis()

Returns the cost basis of the portfolio in the portfolio default currency. This element is optional.

Returns:
Cost basis of the portfolio in the portfolio default currency or undefined for none.

getCurrencyCode

string|undefined getCurrencyCode()

Returns the ISO4217 currency code. This attribute is optional.

Returns:
ISO4217 currency code or undefined for none.

getDaysGain

google.gdata.finance.DaysGain|undefined getDaysGain()

Returns the today's gain for the portfolio in the portfolio default currency. This element is optional.

Returns:
Today's gain for the portfolio in the portfolio default currency or undefined for none.

getGain

google.gdata.finance.Gain|undefined getGain()

Returns the gain for the portfolio in the portfolio default currency. This element is optional.

Returns:
Gain for the portfolio in the portfolio default currency or undefined for none.

getGainPercentage

number|undefined getGainPercentage()

Returns the percentage gain. This attribute is optional.

Returns:
Percentage gain or undefined for none.

getMarketValue

google.gdata.finance.MarketValue|undefined getMarketValue()

Returns the market value of the portfolio in the portfolio default currency. This element is optional.

Returns:
Market value of the portfolio in the portfolio default currency or undefined for none.

getReturn1w

number|undefined getReturn1w()

Returns the 1 week return (percentage). This attribute is optional.

Returns:
1 week return (percentage) or undefined for none.

getReturn1y

number|undefined getReturn1y()

Returns the 1 year return (percentage). This attribute is optional.

Returns:
1 year return (percentage) or undefined for none.

getReturn3m

number|undefined getReturn3m()

Returns the 3 month return (percentage). This attribute is optional.

Returns:
3 month return (percentage) or undefined for none.

getReturn3y

number|undefined getReturn3y()

Returns the 3 year return (percentage). This attribute is optional.

Returns:
3 year return (percentage) or undefined for none.

getReturn4w

number|undefined getReturn4w()

Returns the 4 week return (percentage). This attribute is optional.

Returns:
4 week return (percentage) or undefined for none.

getReturn5y

number|undefined getReturn5y()

Returns the 5 year return (percentage). This attribute is optional.

Returns:
5 year return (percentage) or undefined for none.

getReturnOverall

number|undefined getReturnOverall()

Returns the overall return (percentage). This attribute is optional.

Returns:
Overall return (percentage) or undefined for none.

getReturnYTD

number|undefined getReturnYTD()

Returns the Year-to-date return (percentage). This attribute is optional.

Returns:
Year-to-date return (percentage) or undefined for none.

setCostBasis

void setCostBasis(<google.gdata.finance.CostBasis|Object|undefined> costBasis)

Sets the cost basis of the portfolio in the portfolio default currency. This element is optional.

Parameters:
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.

setCurrencyCode

void setCurrencyCode(<string|undefined> currencyCode)

Sets the ISO4217 currency code. This attribute is optional.

Parameters:
currencyCode - ISO4217 currency code or undefined for none.

setDaysGain

void setDaysGain(<google.gdata.finance.DaysGain|Object|undefined> daysGain)

Sets the today's gain for the portfolio in the portfolio default currency. This element is optional.

Parameters:
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.

setGain

void setGain(<google.gdata.finance.Gain|Object|undefined> gain)

Sets the gain for the portfolio in the portfolio default currency. This element is optional.

Parameters:
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.

setGainPercentage

void setGainPercentage(<number|undefined> gainPercentage)

Sets the percentage gain. This attribute is optional.

Parameters:
gainPercentage - Percentage gain or undefined for none.

setMarketValue

void setMarketValue(<google.gdata.finance.MarketValue|Object|undefined> marketValue)

Sets the market value of the portfolio in the portfolio default currency. This element is optional.

Parameters:
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.

setReturn1w

void setReturn1w(<number|undefined> return1w)

Sets the 1 week return (percentage). This attribute is optional.

Parameters:
return1w - 1 week return (percentage) or undefined for none.

setReturn1y

void setReturn1y(<number|undefined> return1y)

Sets the 1 year return (percentage). This attribute is optional.

Parameters:
return1y - 1 year return (percentage) or undefined for none.

setReturn3m

void setReturn3m(<number|undefined> return3m)

Sets the 3 month return (percentage). This attribute is optional.

Parameters:
return3m - 3 month return (percentage) or undefined for none.

setReturn3y

void setReturn3y(<number|undefined> return3y)

Sets the 3 year return (percentage). This attribute is optional.

Parameters:
return3y - 3 year return (percentage) or undefined for none.

setReturn4w

void setReturn4w(<number|undefined> return4w)

Sets the 4 week return (percentage). This attribute is optional.

Parameters:
return4w - 4 week return (percentage) or undefined for none.

setReturn5y

void setReturn5y(<number|undefined> return5y)

Sets the 5 year return (percentage). This attribute is optional.

Parameters:
return5y - 5 year return (percentage) or undefined for none.

setReturnOverall

void setReturnOverall(<number|undefined> returnOverall)

Sets the overall return (percentage). This attribute is optional.

Parameters:
returnOverall - Overall return (percentage) or undefined for none.

setReturnYTD

void setReturnYTD(<number|undefined> returnYTD)

Sets the Year-to-date return (percentage). This attribute is optional.

Parameters:
returnYTD - Year-to-date return (percentage) or undefined for none.