Building A Custom Widget: Stock Ticker Widget - akumina/AkuminaTraining GitHub Wiki
- Download digitalworkplace.custom.js from the “/Style Library/DigitalWorkplace/JS” folder within SharePoint
- Paste the Widget Definition within digitalworkplace.custom.js
- Upload the updated digitalworkplace.custom.js to the “/Style Library/DigitalWorkplace/JS” folder within SharePoint
- In the Management Apps tab of AppManager, click on the View Manager. Click “Add New”. In the left pane navigate to “/DigitalWorkplace/Content/Templates/” for the folder path. Click “Choose File”, navigate to your custom template (StockList.html). Click “Save”. Repeat for StockListChart.html.
- In the Management Apps tab of AppManager, click on the Widget Manager app. Then click on Add Widget. Create your widget with the values in the Widget Manager – Widget Definition section. Click Save & Exit
- In the Manage Widgets window, find StockTicker and click its ‘View Widget Definitions’ button. Then click on ‘Add New’. Create your widget instance with the values in the Widget Manager – Widget Instance section. Click Save & Exit
- Copy the Widget Snippet of your Widget Instance.
- Paste the snippet into a Content Editor Web Part on a page within the site. Publish the page.
- Flush your cache by clicking on the Akumina icon in the left rail, clicking the refresh icon, then clicking “Refresh All Cache”
- Refresh the page. You will see your Stock Ticker Widget
if ((typeof Akumina.AddIn.StockTickerWidget) === 'undefined') {
Akumina.AddIn.StockTickerWidget = function () {
var _cur = this;
this.GetPropertyValue = function (requestIn, key, defaultValue) {
var propertyValue = "";
for (var prop in requestIn) {
if (key.toLowerCase() == prop.toLowerCase()) {
propertyValue = requestIn[prop];
break;
}
}
return (propertyValue == undefined || propertyValue.toString().trim() == "") ? defaultValue : propertyValue;
};
this.SetDefaultsProperties = function (requestIn) {
var requestOut = requestIn;
requestOut.SenderId = _cur.GetPropertyValue(requestIn, "id", "");
requestOut.DisplayTemplateUrl = _cur.GetPropertyValue(requestIn, "displaytemplateurl", "");
requestOut.StockList = _cur.GetPropertyValue(requestIn, "stocklist", "");
requestOut.callbackMethod = _cur.GetPropertyValue(requestIn, "callbackmethod", "");
return requestOut;
};
this.Init = function (StockTickerRequest) {
_cur.appWebUrl = decodeURIComponent(Akumina.AddIn.Utilities.getQueryStringParameter("SPAppWebUrl", ""));
_cur.hostUrl = decodeURIComponent(Akumina.AddIn.Utilities.getQueryStringParameter("SPHostUrl", ""));
_cur.StockTickerRequest = _cur.SetDefaultsProperties(StockTickerRequest);
_cur.StockTickerRequest.EditMode = Akumina.AddIn.Utilities.getEditMode();
var widgetName = "StockTicker";
Akumina.Digispace.WidgetPropertyViews.AddViewForProperty(widgetName, "DisplayTemplateUrl", "TemplatePicker");
_cur.Prerender();
};
this.Prerender = function () {
var targetDiv = this.StockTickerRequest.SenderId;
$("#" + targetDiv).html(Akumina.Digispace.ConfigurationContext.LoadingTemplateHtml);
Akumina.Digispace.AppPart.Eventing.Subscribe('/loader/completed/', _cur.Render);
Akumina.Digispace.AppPart.Eventing.Subscribe('/widget/updated/', _cur.RefreshWidget);
};
this.Render = function () {
var stocklist = _cur.StockTickerRequest.StockList;
$.getJSON('https://finance.google.com/finance/info?client=ig&q=' + stocklist + '&callback=?', function (response) {
_cur.Success(response);
});
};
this.RefreshWidget = function (newProps) {
if (newProps["id"] == _cur.StockTickerRequest.SenderId) {
_cur.StockTickerRequest = _cur.SetDefaultsProperties(newProps);
_cur.Render();
}
};
this.Success = function(response)
{
var data = {};
data.Items = [];
data.SenderId = _cur.StockTickerRequest.SenderId;
for (i = 0; i < response.length; i++) {
var stockInfo = response[i];
var title = stockInfo.t;
var url = "http://finance.yahoo.com/q?s=" + stockInfo.t;
var chart = "http://chart.finance.yahoo.com/z?s=" + stockInfo.t + "&t=1d";
var changeValue = parseFloat(stockInfo.c);
var changeIsPositive = changeValue >= 0;
var stockPrice = stockInfo.l;
var differential = stockInfo.c;
var percent = stockInfo.cp;
var time = stockInfo.lt;
var stockItem = {
"Title": title,
"StockTitle": title,
"Url": url,
"Positive": changeIsPositive,
"Price": stockPrice,
"Differential": differential,
"Percent": percent,
"Time": time,
"Chart": chart
};
data.Items.push(stockItem);
}
if (!_cur.StockTickerRequest.EditMode) {
_cur.BindTemplate(_cur.StockTickerRequest.DisplayTemplateUrl, data, _cur.StockTickerRequest.SenderId);
}
};
this.BindTemplate = function (templateUri, data, targetDiv) {
new Akumina.Digispace.AppPart.Data().Templates.ParseTemplate(templateUri, data).done(function (html) {
$("#" + targetDiv).html(html);
});
};
}
};We define the Stock Ticker widget with this line.
Helper method to get properties
We set the default values to properties if nothing is passed in for them.
this.Init calls the functions to render the widget. We also specify the widget name that we will use for the Widget Class step and we subscribe the widget to the Template Picker.
this.Prerender defines what will show while the widget is rendering. We use subscriptions to call the this.Render function when loading is complete and this.RefreshWidget when the widget is updated.
We make a GET call to google finance with our stocklist values as paramters. Upon successful query we call the Success function
We assign the results from our GET to values to be used in our template
We bind our data to our template and render
this.RefreshWidget resets the properties and calls this.Render
Create a file called StockTicker.html and paste the following markup within
<style>
.ia-announcement-wrapper
{
background-color:white;
padding:10px;
}
</style>
<div class="interAction">
<div class="ia-announcement-wrapper">
<div class="ia-control-header">
<span class="ia-control-header-icon fa fa-{{WebPartIcon}}"></span>
<h3 class="ia-control-header-heading">{{WebPartTitle}}</h3>
</div>
<div class="ia-announcements">
<ul>
{{#Items}}
<li>
<h4 class="ia-announcement-title"><a href="{{Url}}">{{StockTitle}}</a></h4>
{{#if Positive}}
<p class="ia-annoucement-summary">{{Price}} <font color="green"> {{Differential}} ({{Percent}}%)</font>
<br/>
{{Time}}</p>
{{else}}
<p class="ia-annoucement-summary">{{Price}} <font color="red"> {{Differential}} ({{Percent}}%)</font>
<br/>
{{Time}}</p>
{{/if}}
</li>
{{/Items}}
</ul>
</div>
</div>
</div>Create a file called StockTickerChart.html and paste the following markup within
<style>
.ia-announcement-wrapper
{
background-color:white;
padding:10px;
}
</style>
<div class="interAction">
<div class="ia-announcement-wrapper">
<div class="ia-control-header">
<span class="ia-control-header-icon fa fa-{{WebPartIcon}}"></span>
<h3 class="ia-control-header-heading">{{WebPartTitle}}</h3>
</div>
<div class="ia-announcements">
{{#Items}}
<img class="stockticker-chart" src="{{Chart}}">
{{/Items}}
</div>
</div>
</div>
StockTicker
Akumina.AddIn.StockTickerWidget
Stocklist
MSFT,APPL,ATVI,AMZN,GOOG
Text
###WidgetViews
View 1
/Style Library/DigitalWorkplace/Content/Templates/StockList.html
View 2
/Style Library/DigitalWorkplace/Content/Templates/StockListChart.html
Stock Ticker 1
MSFT,AAPL,ATVI,AMZN,GOOG
Checked
Selected
Checked
Selected
In your Digital Workplace Site, click on the Akumina Icon in the Rail, click on the pencil, then click on your StockTickerWidget to bring up the Widget Manager. Change the view to View 2. Add TSLA to the stocklist. Click Update. The new view will be showing daily charts for all of the stocks and the TSLA stock info will now appear
- In the Management Apps Tab of AppManager, click on the Dashboard Widget Manager. Then Click Add New. Add the instance of the StockTickerWidget we just created. Use the Dashboard Widget Manager for reference. Click Save & Exit
- Navigate to the Dashboard.aspx page of your site. Click Customize, check StockTickerDashboard. Click Save.
- Flush your cache by clicking on the Akumina icon in the left rail, clicking the refresh icon, then clicking “Refresh All Cache”
- Refresh the page. You will see your StockTickerWidget
StockTickerDashboard
Stock Ticker 1
Checked
For the AngularJS version of this example, please see Building A Custom Widget: Angular Stock Ticker Widget
For more info on Custom Widgets see the following articles