Q4Widgets API Documentation

q4.euronews

A News widget which allows you to retrive data by client Exchange & Symbol.
Script link
q4.euro-news.1.0.5.min.js
Source file
q4.euro-news.js, line 2
Requires

Options

url string
The URL of the API
Default value
https://vurosyg0xi.execute-api.us-east-1.amazonaws.com/dev/
symbol string
The client symbol of the company you wish to look-up
Default value
AAPL
exchange string
The Xignite exchange code for the client
Default value
XNAS
apiKey string
Client specific API Key
Default value
GfClqathzX4tZWOf2JpBZ7k2gNWzvvSD1fFJIVMi
logProviders string
Write a list of available newswires to your console. The returned number can be passed as a `newsWireId` to filter the list of items returned.
PR Newswire   : US Press Releases XHTML     : (14)
PR Newswire   : Press Releases US - English : (110)
Business Wire : US Press Releases XHTML     : (6003)
Business Wire : Press Releases - English    : (25)
Default value
true
hiddenClass string
A CSS class to hide an element
Default value
js--hidden
loadingClass string
A CSS class to add to the widget while data is loading. This can be used to show and hide elements within the widget.
Default value
js--loading
backClass string
A CSS class for the back button
Default value
js--back
usePagination boolean
TODO - Not currently supported
Default value
false
itemsPerPage number
Number of items to render on the page. Only used if `usePagination` is set to true
Default value
100
paginationTpl string
TODO - Not currently supported
dateFormat string
A date format string, which can be used in the template as `{{date}}`.
Default value
MM d, yy
Example
mm/dd/yy
newsWireId number
TODO - Not currently implemented inside the API
newsYearsTpl string
A Mustache.js template for a single item for rendering the years container
Default value
{{#.}}<a href="#{{.}}" class="module_nav-link">{{.}}</a>{{/.}}
newsTpl string
A Mustache.js template for a single item for rendering the years container
newsItemContainer string
A selector for the news items, must exist within the news container.
Default value
.module_container--content
newsDetailsTpl string
A Mustache.js template for a single news item
newsDetailsContainer string
A container where news details will be added
Default value
.module_container--details
errorTpl string
A Mustache.js template which will display if there is no data for the selected ticker
Default value
<p>There are no items available for {{symbol}}
yearContainer string
A selector for the years container, must exist within the news container.
Default value
.module_nav
beforeRenderYears function
A callback that fires before the years are rendered.
Parameters
event Event
The event object.
templateData Object
Template data for the years list.
beforeRenderItems function
A callback that fires before the items list is rendered.
Parameters
event Event
The event object.
templateData Object
Template data for the items list.
yearsComplete function
A callback that allows you to setup any require click handlers for years.
Parameters
event Event
A callback that allows you to setup any require click handlers for years.
options Object
A callback that allows you to setup any require click handlers for years.
itemsComplete function
A callback that allows you to setup any require click handlers for your news items.
Parameters
event Event
A callback that allows you to setup any require click handlers for your news items.
options Object
A callback that allows you to setup any require click handlers for your news items.

Methods

reloadNews
Reload news items.
Parameters
year number
Reload news items.