Help: Stock List Template Variables

For more help, visit the WebGUI Community Wiki.

extrasFolder
The url to the extras folder containing css files and images used by the Stock List application
editUrl
The url to the page where users can customize stocks
isVisitor
Whether or not the current user is a visitor. This returns true if the user is not authenticated against the system
stock.display.url
General url to the page that displays details for individual stocks. A stock symbol must be added to the end of this url
lastUpdate.default
default date and time format for the date and time stocks were updated by the returning sources
lastUpdate.intl
international date and time format for the date and time stocks were updated by the returning sources
lastUpdate.us
US date and time format for the date and time stocks were updated by the returning sources
stocks.loop
Loop containing all default or personalized stocks
stocks.symbol
Stock Symbol
stocks.name
Company or Mutual Fund Name
stocks.last
Last Price
stocks.high
Highest trade today
stocks.low
Lowest trade today
stocks.date
Last Trade Date (MM/DD/YY format)
stocks.time
Last Trade Time
stocks.net
Net Change
stocks.net.isDown
Net Change is negative
stocks.net.isUp
Net Change is positive
stocks.net.noChange
Net Change is zero
stocks.net.icon
Icon associated with net change (up, down, even)
stocks.p_change
Percent Change from previous day's close
stocks.volume
Day's Volume
stocks.volume.millions
Day's Volume In Millions
stocks.avg_vol
Average Daily Vol
stocks.bid
Bid
stocks.ask
Ask
stocks.close
Previous Close
stocks.open
Today's Open
stocks.day_range
Day's Range
stocks.year_range
52-Week Range
stocks.year_high
52-Week High
stocks.year_low
52-Week Low
stocks.eps
Earnings per Share
stocks.pe
P/E Ratio
stocks.div_date
Dividend Pay Date
stocks.div
Dividend per Share
stocks.div_yield
Dividend Yield
stocks.cap
Market Capitalization
stocks.ex_div
Ex-Dividend Date
stocks.nav
Net Asset Value
stocks.yield
Yield (usually 30 day avg)
stocks.exchange
The exchange the information was obtained from.
stocks.success
Did the stock successfully return information? (true/false)
stocks.errormsg
If success is false, this field may contain the reason why.
stocks.method
The module (as could be passed to fetch) which found this information.
pagination.firstPage
A link to the first page in the paginator.
pagination.firstPageUrl
The url component of pagination.firstPage broken out.
pagination.firstPageText
The text component of pagination.firstPage broken out.
pagination.isFirstPage
A boolean indicating whether the current page is the first page.
pagination.lastPage
A link to the last page in the paginator.
pagination.lastPageUrl
The url component of pagination.lastPage broken out.
pagination.lastPageText
The text component of pagination.lastPage broken out.
pagination.isLastPage
A boolean indicating whether the current page is the last page.
pagination.nextPage
A link to the next page in the paginator relative to the current page.
pagination.nextPageUrl
The url component of pagination.nextPage broken out.
pagination.nextPageText
The text component of pagination.nextPage broken out.
pagination.previousPage
A link to the previous page in the paginator relative to the current page.
pagination.previousPageUrl
The url component of pagination.previousPage broken out.
pagination.previousPageText
The text component of pagination.previousPage broken out.
pagination.pageNumber
The current page number.
pagination.pageCount
The total number of pages.
pagination.pageCount.isMultiple
A boolean indicating whether there is more than one page.
pagination.pageList
A list of links to every page in the paginator.
pagination.pageLoop
Same as pagination.pageList except broken into individual elements.
pagination.url
The URL of a page in the page loop.
pagination.text
The number of a page in the page loop.
pagination.range
Displays the range of available pages, in a start - end format.
pagination.activePage
A boolean which will be true if the this page in the pageLoop is the currently viewed page.
pagination.pageList.upTo20
A list of links to the 20 nearest in the paginator relative to the current page. So if you're on page 60, you'll see links for 50-70.
pagination.pageLoop.upTo20
Same as pagination.pageList.upTo20 except broken into individual elements.
pagination.url
The URL of a page in the page loop.
pagination.text
The number of a page in the page loop.
pagination.range
Displays the range of available pages, in a start - end format.
pagination.activePage
A boolean which will be true if the this page in the pageLoop is the currently viewed page.
pagination.pageList.upTo10
A list of links to the 10 nearest in the paginator relative to the current page. So if you're on page 20, you'll see links for 15-25.
pagination.pageLoop.upTo10
Same as pagination.pageList.upTo10 except broken into individual elements.
pagination.url
The URL of a page in the page loop.
pagination.text
The number of a page in the page loop.
pagination.range
Displays the range of available pages, in a start - end format.
pagination.activePage
A boolean which will be true if the this page in the pageLoop is the currently viewed page.
templateId
The ID of the template used to show the main screen for this Asset.
displayTemplateId
The ID of the template used to show the user details about their stocks.
defaultStocks
The default list of stocks if the user has not chosen any. This is a string separated by newlines.
source
The internet source to be used as the source of stock information.
failover
A conditional indicating whether or not failover has been set for this Stock Data Asset.
displayTitle
A conditional variable for whether or not the title should be displayed.
description
The description of this wobject.
styleTemplateId
The assetId of the template for displaying the Asset.
printableStyleTemplateId
The assetId of the template for displaying the Asset for printing.
assetId
The unique identifier for this Asset, in base64 encoding.
assetIdHex
The unique identifier for this Asset, in hexadecimal format.
title
The title of the Asset
menuTitle
The title of the Asset used in Navigations.
url
The Asset's URL.
isHidden
A boolean that will be true if this Asset is set not be displayed in Navigations.
newWindow
A boolean that will be true if this Asset is set open in a new browser window.
encryptPage
A boolean that will be true if this Asset is set to be served over SSL.
ownerUserId
The ID of the user who owns this Asset.
groupIdView
The ID of the group that is allowed to view this Asset.
groupIdEdit
The ID of the group that is allowed to edit this Asset.
synopsis
A short description of the contents of the Asset.
extraHeadTags
Extra tags that will be added to the header of the page containing the Asset. These will be included by default so you do not need to add them youself, unless you want them to be in there twice.
isPackage
A boolean that will be true if this Asset is set to be a Package.
isPrototype
A boolean that will be true if this Asset is set to be a prototype.
status
With respect to version control, the status of this Asset. Typically these are the English strings "approved", "pending", "committed".
assetSize
How big this asset is in bytes. The sum of all database fields and attachments.
keywords
This will be a string with the keywords for this asset. Individual keywords will be joined with spaces, unless the keyword contains spaces, in which case it will be quoted.
 
 
Admin Console
Help: Stock List Template Variables
*
Admin Console