GData JavaScript Client 1.6

Class google.gdata.finance.PositionData

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

class google.gdata.finance.PositionData


Data for the position.
Defined in gdata.js


Field Summary
 Object $costBasisClass_
          
 Object $daysGainClass_
          
 Object $gainClass_
          
 Object $marketValueClass_
          
 {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).
 {String|undefined} shares
          Number of shares belonging to the position.
 
Constructor Summary
google.gdata.finance.PositionData(<Object> opt_params)
            Constructs a position 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 position in the portfolio default currency (and exchange currency if it differs).
 google.gdata.finance.DaysGain|undefined getDaysGain()
           Returns the today's gain for the position in the portfolio default currency (and exchange currency if it differs).
 google.gdata.finance.Gain|undefined getGain()
           Returns the gain for the position in the portfolio default currency (and exchange currency if it differs).
 Number|undefined getGainPercentage()
           Returns the percentage gain.
 google.gdata.finance.MarketValue|undefined getMarketValue()
           Returns the market value of the position in the portfolio default currency (and exchange currency if it differs).
 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).
 Number|undefined getShares()
           Returns the number of shares belonging to the position.
 void setCostBasis(<google.gdata.finance.CostBasis|Object|undefined> costBasis)
           Sets the cost basis of the position in the portfolio default currency (and exchange currency if it differs).
 void setDaysGain(<google.gdata.finance.DaysGain|Object|undefined> daysGain)
           Sets the today's gain for the position in the portfolio default currency (and exchange currency if it differs).
 void setGain(<google.gdata.finance.Gain|Object|undefined> gain)
           Sets the gain for the position in the portfolio default currency (and exchange currency if it differs).
 void setGainPercentage(<Number|undefined> gainPercentage)
           Sets the percentage gain.
 void setMarketValue(<google.gdata.finance.MarketValue|Object|undefined> marketValue)
           Sets the market value of the position in the portfolio default currency (and exchange currency if it differs).
 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).
 void setShares(<Number|undefined> shares)
           Sets the number of shares belonging to the position.

Field Detail

$costBasisClass_

Object $costBasisClass_

$daysGainClass_

Object $daysGainClass_

$gainClass_

Object $gainClass_

$marketValueClass_

Object $marketValueClass_

gainPercentage

{String|undefined} gainPercentage

return1w

{String|undefined} return1w

return1y

{String|undefined} return1y

return3m

{String|undefined} return3m

return3y

{String|undefined} return3y

return4w

{String|undefined} return4w

return5y

{String|undefined} return5y

returnOverall

{String|undefined} returnOverall

returnYTD

{String|undefined} returnYTD

shares

{String|undefined} shares

Constructor Detail

google.gdata.finance.PositionData

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

Method Detail

getCostBasis

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

getDaysGain

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

getGain

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

getGainPercentage

Number|undefined getGainPercentage()

getMarketValue

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

getReturn1w

Number|undefined getReturn1w()

getReturn1y

Number|undefined getReturn1y()

getReturn3m

Number|undefined getReturn3m()

getReturn3y

Number|undefined getReturn3y()

getReturn4w

Number|undefined getReturn4w()

getReturn5y

Number|undefined getReturn5y()

getReturnOverall

Number|undefined getReturnOverall()

getReturnYTD

Number|undefined getReturnYTD()

getShares

Number|undefined getShares()

setCostBasis

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

setDaysGain

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

setGain

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

setGainPercentage

void setGainPercentage(<Number|undefined> gainPercentage)

setMarketValue

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

setReturn1w

void setReturn1w(<Number|undefined> return1w)

setReturn1y

void setReturn1y(<Number|undefined> return1y)

setReturn3m

void setReturn3m(<Number|undefined> return3m)

setReturn3y

void setReturn3y(<Number|undefined> return3y)

setReturn4w

void setReturn4w(<Number|undefined> return4w)

setReturn5y

void setReturn5y(<Number|undefined> return5y)

setReturnOverall

void setReturnOverall(<Number|undefined> returnOverall)

setReturnYTD

void setReturnYTD(<Number|undefined> returnYTD)

setShares

void setShares(<Number|undefined> shares)

GData JavaScript Client 1.6

Documentation generated by JSDoc on Tue Oct 14 17:57:25 2008