Financial Web Component 
Introduction
rise-financial is a Polymer Web Component that works together with the Rise Vision Financial Selector, a web app for managing financial content. It retrieves the financial list and its corresponding instruments from Firebase. Data is refreshed in realtime, so any changes that are made to a particular financial list in the Financial Selector are immediately propagated to the rise-financial component.
Usage
To use rise-financial, you should first install it using Bower:
bower install https://github.com/Rise-Vision/rise-financial.git
Next, construct your HTML page. You should include webcomponents-lite.min.js before any code that touches the DOM, and load the web component using an HTML import.
Example
<!DOCTYPE html>
<html>
<head>
<script src="bower_components/webcomponentsjs/webcomponents-lite.min.js"></script>
<link rel="import" href="bower_components/rise-financial/rise-financial.html">
</head>
<body>
<rise-financial
id="myListID"
financial-list="my-list"
instrument-fields='["instrument", "name", "lastPrice", "netChange"]'>
</rise-financial>
<script>
// Listen for "WebComponentsReady" event.
window.addEventListener( "WebComponentsReady", function( e ) {
const financial = document.querySelector( "rise-financial" );
financial.addEventListener( "rise-financial-response", ( e ) => {
console.log( e.detail );
} );
financial.addEventListener( "rise-financial-no-data", ( e ) => {
console.log( "No data available" );
} );
// Request the financial data.
financial.go();
});
</script>
</body>
</html>
Realtime Data
To request realtime data, the type attribute can either be left off or it can be set to realtime.
Valid values for the instrument-fields attribute for realtime data are: accumulatedVolume, ask, bid, code, dayHigh, dayLow, daysOfWeek, endTime, historicClose, instrument, lastPrice, name, netChange, percentChange, startTime, timeZone, timeZoneOffset, tradeTime, updateInterval, yearHigh, yearLow, yield logoURL and yieldChange.
If no instrument-fields attribute is provided, all fields are returned by default.
Example
<rise-financial
financial-list="my-list"
instrument-fields='["instrument", "name"]'>
</rise-financial>
Historical Data
To request historical data, the type attribute must be set to historical and duration must be set to one of: Day, Week, 1M, 3M, 6M, 1Y or 5Y.
Valid values for the instrument-fields attribute for historical data are: accumulatedVolume, closePrice, intervalVolume, percentChange and tradeTime.
If no instrument-fields attribute is provided, all fields are returned by default.
In case the list of instruments contains more than one instrument an attribute symbol can be set to specify which instrument from the list the historical data needs to be retrieved.
Example
<rise-financial
id = "myHistoricalID"
duration="1M"
financial-list="my-list"
instrument-fields='["closePrice", "percentChange"]'
type="historical"
symbol="AAPL.O">
</rise-financial>
Response Object
rise-financial returns an object of the following format:
data is an object with cols and rows properties, where cols is an array that contains additional information about the requested fields, and rows is an array that contains the actual data.
instruments is an object that provides details about every instrument found in the financial list.
Documentation
For further documentation on rise-financial attributes, methods, usage, and a comprehensive demo, please see here.
Built With
- Polymer
- npm
- Bower
- Gulp
- Polyserve
- Firebase Realtime Database JavaScript SDK
- web-component-tester for testing
Development
Dependencies
- Git - Git is a free and open source distributed version control system that is used to manage our source code on Github.
- npm & Node.js - npm is the default package manager for Node.js. npm runs through the command line and manages dependencies for an application. These dependencies are listed in the package.json file.
- Bower - Bower is a package manager for Javascript libraries and frameworks. All third-party Javascript dependencies are listed in the bower.json file.
- Gulp - Gulp is a Javascript task runner. It lints, runs unit and E2E (end-to-end) tests, minimizes files, etc. Gulp tasks are defined in gulpfile.js.
- Polyserve - A simple web server for using bower components locally.
Local Development Environment Setup and Installation
To make changes to the web component, you'll first need to install the dependencies:
- Git
- Node.js and npm
- Bower - To install Bower, run the following command in Terminal:
npm install -g bower. Should you encounter any errors, try running the following command instead:sudo npm install -g bower. - Gulp - To install Gulp, run the following command in Terminal:
npm install -g gulp. Should you encounter any errors, try running the following command instead:sudo npm install -g gulp. - Polyserve - To install Polyserve, run the following command in Terminal:
npm install -g polyserve. Should you encounter any errors, try running the following command instead:sudo npm install -g polyserve.
The web components can now be installed by executing the following commands in Terminal:
git clone https://github.com/Rise-Vision/rise-financial.git
cd rise-financial
npm install
bower install
Run Locally
To access the demo locally, run the following command in Terminal: polyserve
Now in your browser, navigate to:
localhost:8080/components/rise-financial/demo/index.html
Testing
You can run the suite of tests either by command terminal or via a local web server using Polyserve.
Command Terminal
Execute the following command in Terminal to run tests:
NODE_ENV=test yarn run test
Local Server
Run the following command in Terminal: polyserve.
Now in your browser, navigate to:
localhost:8080/components/rise-financial/test/index.html
Deployment
Once you are satisifed with your changes, deploy the contents of the bower_components folder to a folder on your server and also create a rise-financial folder within your folder and upload rise-financial.html to it. You can then use the web component by following the Usage instructions.
Submitting Issues
If you encounter problems or find defects we really want to hear about them. If you could take the time to add them as issues to this Repository it would be most appreciated. When reporting issues, please use the following format where applicable:
Reproduction Steps
- did this
- then that
- followed by this (screenshots / video captures always help)
Expected Results
What you expected to happen.
Actual Results
What actually happened. (screenshots / video captures always help)
Contributing
All contributions are greatly appreciated and welcome! If you would first like to sound out your contribution ideas, please post your thoughts to our community, otherwise submit a pull request and we will do our best to incorporate it. Please be sure to submit test cases with your code changes where appropriate.
Resources
If you have any questions or problems, please don't hesitate to join our lively and responsive community at http://community.risevision.com.
If you are looking for user documentation on Rise Vision, please see https://help.risevision.com/user.
If you would like more information on developing applications for Rise Vision, please visit https://help.risevision.com/developer.
Facilitator
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent