B2i JavaScript API Documentation
JavaScript examples and configuration options for B2i investor relations modules.
CONFIDENTIAL — B2I TECHNOLOGIES, INC.
This information cannot be distributed, shared or copied to any third party without B2i Technologies, Inc.’s prior written consent.
B2i Explorer — examples and explanations.
Table of Contents
Automated modules
SEC Filings
Table layout 1 - SEC module is now database driven - custom layouts are possible
<div id="SECdiv"></div>
<script language="javascript" type="text/javascript" src="https://www.b2i.us/b2i/SECapi.js?v=1.0.8.3"></script>
<script language="javascript" type="text/javascript">
window.addEventListener('load', function() {
oSEC.BizID="2626";
oSEC.sKey="Sf6Ic9Gy8";
oSEC.sHttp="https";
oSEC.sDiv="SECdiv";
oSEC.lo="1"; // Layout 1 for SEC List table
oSEC.t=""; // Form Type filter set to empty
oSEC.sf="1"; // show form turned on
oSEC.n="1"; // navigation turned on
oSEC.SecVer="2";
getSecData();
});
</script>
SEC Detailed View example
SEC module is now database driven - custom layouts possible
<div id="SECdiv10k"></div>
<script language="javascript" type="text/javascript" src="https://www.b2i.us/b2i/SECapi.js?v=1.0.8.3"></script>
<script language="javascript" type="text/javascript">
window.addEventListener('load', function() {
oSEC.BizID="2626";
oSEC.sKey="Sf6Ic9Gy8";
oSEC.sHttp="https";
oSEC.sDiv="SECdiv10k"; // unique name set for div
oSEC.lo="3"; // Layout 3 for SEC enhanced display
oSEC.DocListOpen="0"; // Document list open by default
oSEC.t="10-Konly"; // Form Type filter set
oSEC.sf="0"; // show form turned off
oSEC.n="0"; // navigation turned off
oSEC.SecVer="2";
getSecData();
});
</script>
You can add CSS for the Filing Viewer Page in the IR Office portal.
| oSEC.lo="0"; | Layout: default is DIV, lo="1" will display <table> output, lo="3" for Single/Enhanced Filing View | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.sDiv=""; | Sets the location to render the data | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.fonticon="1"; | Use Font icons instead of default images. | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.DocListOpen="0"; | Turn this setting off to collapse the documents list on the enhanced views. | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.t=""; | Form type filter to limit display of forms: Example: oSEC.t="10-K"; *** See more detail below | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.sf="0"; | Search form: default is show search form, setting to 0 will hide the search form | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.sh="0"; | Show column headers: default is show column headers, setting to 0 will hide the column headers | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.sg="1"; | Show groups: default is off, setting to 1 will display the group column | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.n=""; | Navigation: default is show navigation, setting to 0 will hide the navigation | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.c="10"; | Count: how many items are displayed per page, default is 20 | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.y=""; | Year: setting a year will limit filings to only that year | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.currentyear="1" | Current year: setting to only show the current year items in any of the SEC displays | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.sg="1"; | ShowGroups: Show Groups on list view | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.CSS="1"; | Set to 0 to turn off default css | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.df="1"; | Date Format: 1-5, default is 1, 1= mmm dd, yyyy 2= mm/dd/yyyy 3= dd/mm/yyyy 4= dd mmm yyyy 5= Month dd,yyyy | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.LangID="2"; | Language to display text items. Additional languages must be initialized. | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.OpenLinks=""; | set to "1" for new tab, "2" for new window, "3" for floating div | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.OpenIcons=""; | set to "1" for new tab, "2" for new window, "3" for floating div | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.TextHeader=""; | Empty by default. | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.sPdf=""; | Image URL for PDF files | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.sHtm=""; | Image URL for Html files | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.sDoc=""; | Image URL for Doc files | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.sXls=""; | Image URL for Xls files | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.sXbrl=""; | Image URL for Xbrl files | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.sZip=""; | Image URL for Zip files | ||||||||||||||||||||||||||||||||||||||||||||
Form Type Filters
US Filers - Form Filters
ADR Filers - Form Filters
|
|||||||||||||||||||||||||||||||||||||||||||||
| oSEC.iStoryWidth="600"; | Content floating div width reduced size: default 600 px | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.iStoryHeight="600"; | Content floating div height reduced size: default 600 px | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.iStoryMaxWidth=""; | Content floating div width expanded size: default screen size -80 px | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.iStoryMaxHeight=""; | Content floating div height expanded size: default screen size -80 px | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.iLeftOffset="0"; | Content floating div offset from left: default 0 | ||||||||||||||||||||||||||||||||||||||||||||
| oSEC.iTopOffset="0"; | Content floating div offset from top: default 0 | ||||||||||||||||||||||||||||||||||||||||||||
Financials
<div id="Fin1Div"></div> When using Financials multiple times on same page, set unique div ids
<script language="JavaScript" src="https://www.b2i.us/b2i/FundamentalApi.asp?v=1.0.8.3" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
window.addEventListener('load', function() {
oFinancials.BizID="2626";
oFinancials.sKey="Sf6Ic9Gy8";
oFinancials.Symbol="OCC";
oFinancials.sDiv="Fin1Div";
oFinancials.sHttp="https";
oFinancials.Mode="0";
getFinancialsData();
});
</script>
| oFinancials.sDiv=""; | Sets the location to render the data | ||||||||||||
| oFinancials.Mode="1"; | Multiple disply options | ||||||||||||
| oFinancials.Tab="1"; | Tabs 1-3 When using Mode="0" to display Tabs. This allows you to set the Tab selected by default. | ||||||||||||
|
|||||||||||||
Press Releases List (Press, FAQs, Blog, etc...)
<div id="LibDiv"></div>
<script language="javascript" type="text/javascript" src="https://www.b2i.us/b2i/LibraryApi.js?v=1.0.8.3"></script>
<script language="javascript" type="text/javascript">
window.addEventListener('load', function() {
oLib.BizID="2626";
oLib.sDiv="LibDiv";
oLib.sKey="Sf6Ic9Gy8";
oLib.sHttp="https";
oLib.sNav="1";
oLib.sTools="1";
oLib.Count="10";
oLib.iDateFormat="6";
getData();
});
</script>
| oLib.Group="1869"; | Sets the Group when not using the default Press Releases group. This was a required field, now our system sets the group to be used when this parameter is not included. |
| oLib.sDiv="LibDiv"; | Sets the location to render the data - make sure to make unique if using multiple times on the same page. |
| oLib.Output="0"; | Output Layout 0-21, default 0 for table, 1 displays div cards, 2 displays unordered list (no style), 3 displays div cards morestyle, 4 div cardswith image. Visit our LiveView site to view more |
| oLib.sTools="0"; | Set to 1 to show tools - Year select and search box |
| oLib.sNav=""; | set to 0 to hide the paging navigation |
| oLib.Count="10"; | how many items are displayed per page, default is 10 |
| oLib.Offset=""; | Set an offset - items to be skipped - great when using the module twice on page |
| oLib.iDateFormat="1"; | Date Format: 1-6, default is 1, 1= mmm dd, yyyy 2= mm/dd/yyyy 3= dd/mm/yyyy 4= dd mmm yyyy 5= Day, Month dd, yyyy, 6= Month dd,yyyy |
| oLib.ShowDate="1"; | Date Location: 0-3, default is d="1" only usable with default Layout: oLib.Output="0" 0= do not display 1 = display above headline 2 = display on same row as headline 3 = display below Headline. Now that custom layouts are availble, this option is likely to be phased out. |
| oLib.Alink=""; | default is "0" which uses a floating Div. 0 = opens in a floating div 1 = opens in a new tab 2 = opens in the B2i CMS Viewer and uses a custom domain, URL, and template 3 = opens in a new window 4 = opens as PDF - auto-generated or PDF attachment set in B2i portal 5 = open attachment - attachments set in B2i portal 6 = open in the B2i CMS page with custom domain and URLs in new window 7 = open in the B2i CMS page with custom domain and URLs in new tab 8 = uses ViewLink parameter also able to set in B2i portal - place Press_Release_View plugin on another page to show item in full 9 = view in WordPress blog - The best SEO option with formatting controllable within WordPress. Also see the following options: Show Expand se="1" and Use Same Div sd="1" |
| oLib.ViewLink=""; | The View link is used to display the press releases on a separate page. First place the Press Releases Viewer Plugin on a separate page. Next add the link to that page in the Press Release Plugin ViewLink parameter. Currently, Url can not use querystring paramters. |
| oLib.AutoOpen=""; | When using the floating display to show the story, you can set AutoOpen="1" for use with the email and social media links back to the story. |
| oLib.ShowExpand=""; | Set to 1 to make story open in expand on same page |
| oLib.UseSameDiv=""; | Set to 1 to make story consume the div the headlines loaded in. A back link will be placed above and below the story. |
| oLib.ShowSummary="300"; | Set to number of characters of the body to render |
| oLib.UseTemplate=""; | Set to 1 to use a template on the news story - template must be loaded in IR Office portal |
| oLib.CSS="1"; | Set to 0 to turn off default css |
| oLib.RSS="1"; | Set to 0 to hide the RSS image and link to the RSS feed |
| oLib.HeadlineLen=""; | Set a limited amount of characters to return for the headline |
| oLib.iStoryWidth="600"; | Content floating div width reduced size: default 600 px |
| oLib.iStoryHeight="600"; | Content floating div height reduced size: default 600 px |
| oLib.iStoryMaxWidth=""; | Content floating div width expanded size: default screen size -80 px |
| oLib.iStoryMaxHeight=""; | Content floating div height expanded size: default screen size -80 px |
| oLib.iLeftOffset="0"; | Content floating div offset from left: default 0 |
| oLib.iTopOffset="0"; | Content floating div offset from top: default 0 |
Press Releases Viewer
This module can be used in 2 ways to display a press release
- from the list page
- from the email notification when clicking "Continue Reading"
<div id="LibViewDiv"></div>
<script language="javascript" type="text/javascript" src="https://www.b2i.us/b2i/LibraryViewApi.asp?v=1.0.8.3"></script>
<script language="javascript" type="text/javascript">
window.addEventListener('load', function() {
oLibView.BizID="2626";
oLibView.Group="1869";
oLibView.sKey="Sf6Ic9Gy8";
oLibView.sHttp="https";
oLibView.sNav="1";
oLibView.sTools="1";
oLibView.iDateFormat="6";
getPRViewData();
});
</script>
| oLibView.Output="0"; | Output type 0, default 0 - more will be added soon |
| oLibView.sTools="0"; | Set to 1 to show tools - PDF and Print |
| oLibView.sNav=""; | set to 0 to hide the paging navigation |
| oLibView.iDateFormat="1"; | Date Format: 1-6, default is 1, 1= mmm dd, yyyy 2= mm/dd/yyyy 3= dd/mm/yyyy 4= dd mmm yyyy 5= Day, Month dd, yyyy, 6= Month dd,yyyy |
Email Alert Sign-up
<div id="EmailDiv"></div>
<script language="JavaScript" src="https://www.b2i.us/b2i/Emailapi2.asp?v=1.0.8.3" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
window.addEventListener('load', function() {
oEmail.BizID="2626";
oEmail.sKey="Sf6Ic9Gy8";
oEmail.sHttp="https";
getEmailAlertData();
});
</script>
| oEmail.sSubscribeText=""; | This allows you to set a custom subscribe message that is displayed after the user clicks the subscribe button |
| oEmail.sUnsubscribeText=""; | This allows you to set a custom subscribe message that is displayed after the user clicks the subscribe button |
| oEmail.tos="1"; | Email terms of service - by default this does not show; Set to 1 to enable: oEmail.tos="1"; - this setting enables the Terms of Service message. |
| oEmail.tosLabel='Your Text'; | Email terms of service custom text to use |
| oEmail.tosControl="1"; | Allow the terms of service to control when the Subscribe button shows. |
| oEmail.lo="2"; | Email form layout - default: lo="1"; currently 1-4 available |
| oEmail.RequiredName=false; | Require name field, true by default. |
| oEmail.RequiredCompany=false; | Require company field, true by default. |
| oEmail.LabelEmail="Email"; | Text to use for "Email" label |
| oEmail.LabelFirstName="First Name"; | Text to use for "First Name" label |
| oEmail.LabelLastName="Last Name"; | Text to use for "Last Name" label |
| oEmail.LabelCompany="Company"; | Text to use for "Company" label |
| oEmail.List="##"; | Returns a single list based onthe List ID. Retrieve ## from the B2i system. |
| oEmail.CheckAllList=""; | Set to oEmail.CheckAllList="1"; to check all lists by default |
| oEmail.HideAllList=""; | Set to oEmail.HideAllList="1"; to hide all lists by default |
| oEmail.LangID="2"; | Language to display list and text. Additional languages must be initialized. * |
| oEmail.sJoinEndPoint=""; | URL to forward user to after subscribing |
| oEmail.sRemoveEndPoint=""; | URL to forward user to after unsubscribing |
| oEmail.InvTag=""; | Email Sign Up Form with A/B Testing using Contact Tagging when using email form in multiple locations and measuring performance of - defined and viewed in B2i Portal. * |
| oEmail.Group="##"; | Email Group Filters can be used to segment your groups. Group Filters are created in the B2i portal. Example: Using the form only showing a single group like Press releases. * |
| Items with an * require additional configuration. Please contact us |
Email Alert Unsubscribe
<div id="EmailUnDiv"></div>
<script language="JavaScript" src="https://www.b2i.us/b2i/EmailUnapi2.asp?v=1.0.8.3" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
window.addEventListener('load', function() {
oEmailUn.BizID="2626";
oEmailUn.sKey="Sf6Ic9Gy8";
oEmailUn.sHttp="https";
getEmailUnData();
});
</script>
| oEmailUn.LabelEmail="Email"; | Text to use for "Email" label |
| oEmailUn.LabelUnsubscribe="Email"; | Label for Unsubscribe text - Default is lu="Unsubscribe from all email communications." |
| oEmailUn.sUnsubscribeText=""; | This allows you to set a custom subscribe message that is displayed after the user clicks the subscribe button |
| oEmailUn.sRemoveEndPoint=""; | URL to forward user to after they click unsubscribe |
| oEmailUn.tos="1"; | Email terms of service - by default this does not show; Set to 1 to use: oEmail.tos="1"; |
| oEmailUn.tosLabel='Your Text'; | Email terms of service custom text to use |
| oEmailUn.tosControl="1"; | Allow the terms of service to control when the Subscribe button shows. |
| oEmailUn.lo="2"; | Email form layout - default: lo="1"; currently 1 available |
| oEmailUn.LangID="2"; | Language to display list and text. Additional languages must be initialized. * |
| Items with an * require additional configuration. Please contact us |
Stock Detail
More layouts can easily be added contact us. We love expanding our product!
<div id="QuoteDiv"></div>
<script language="JavaScript" src="https://www.b2i.us/b2i/QuoteApi.asp?v=1.0.8.3" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
window.addEventListener('load', function() {
oQuote.BizID="2626";
oQuote.sKey="Sf6Ic9Gy8";
oQuote.Symbol="OCC";
oQuote.sDiv="QuoteDiv"; //When using quote multiple times on same page, set unique div names
oQuote.Format="1";
oQuote.DecLen="2";
oQuote.CSS="1";
oQuote.sHttp="https";
getQuoteData();
</script>
});
| oQuote.Format="1"; | Format for stock data output. Current usage is 1-15 Need a different format, contact us We love expanding our product! |
| oQuote.SymbolDisplay="(OCC)"; | Override the symbol output |
| oQuote.CSS="1"; | Set to 0 to turn off default css |
| oQuote.sDiv=""; | Sets the location to render the data |
| oQuote.Dollar="0"; | Show currency sign on left, set to "1" for dollar, "2" for euro, "3" for £ - pound - Default is "0" for none |
| oQuote.DollarR=""; | Show currency sign on right, set to "1" for p - pound |
| oQuote.DecLen="2"; | Decimal places, Default is 2, dl=4 would show 4 places right of decimal |
| oQuote.DateFormat="0"; | Custom date format
0: 11/19/2020 2:07 PM 1: Nov 19, 2020 2:07 PM 2: 11/19/20 2:07 PM 3: 19/11/2020 2:07 PM 4: 19 Nov 2020 2:07 PM 5: Tuesday, November 19, 2020 2:07 PM 6: November 19, 2020 2:07 PM 7: Nov 19, 2020 8: 19 Nov 2020 |
| oQuote.Exchange=""; | Exchange override |
| oQuote.Centseperator=""; | Cents seperator override - example: oQuote.Centseperator=","; |
| oQuote.Numseperator=""; | Number seperator override - example: oQuote.Numseperator="."; |
| oQuote.Upimage=""; | Custom up arrow image / character
Examples: oQuote.Upimage="https://imageurl.com/imagename.extension"; oQuote.Upimage="↑"; |
| oQuote.Downimage=""; | Custom down arrow image / character
Examples: oQuote.Downimage="https://imageurl.com/imagename.extension"; oQuote.Downimage="↓"; |
Stock Chart New!
Historical chart example
<div id="chartdiv1" style="height:500px;"></div>
<script language="javascript" type="text/javascript" src="https://www.b2i.us/b2i/highchart-b2i.js"></script>
<script language="javascript" type="text/javascript">
GetChart({
BizID: "449",
ApiKey: "Q6i2x9K5p3",
sDiv: "chartdiv1",
Symbol: "EAT",
Exchange: "NYSE: ",
Period: "2",
FillColor: "336699",
CursorColor: "336699",
BGColor: "ffffff"
});
</script>
| oChart.BizID="####"; | Business ID for B2i system- required |
| oChart.ApiKey="xxxxxxxx"; | API key for B2i system - required |
| oChart.sDiv="chartdiv"; | Sets the location to render the data - required |
| oChart.Symbol="XXX"; | Used to retrieve data for the specific symbol - required |
| oChart.Exchange="NYSE"; | Sets the exchange - used in the title if the Title parameter not set |
| oChart.Title="NYSE: EAT"; | Chart title - optional to provide a custom title |
| oChart.TitleColor="000000"; | Chart Title Color, Default 000000 - do not include # |
| oChart.Period="3"; | Chart Period, Default 3 - Set the initial period for the chart |
| oChart.ChartType="candlestick"; | Chart Type - options include candlestick, line, and area, Default candlestick |
| oChart.FillColor="336699"; | Chart Fill Color, Default 336699 - do not include # |
| oChart.CursorColor="336699"; | Chart Cursor Color, Default 336699 - do not include # |
| oChart.BGColor="ffffff"; | Chart Background Color, Default ffffff - do not include # |
| oChart.tooltipTextColor="000000"; | Chart Tooltip Text Color, Default 000000 - do not include # |
| oChart.tooltipBGColor="ffffff"; | Chart Tooltip Background Color, Default ffffff - do not include # |
| oChart.LabelColor="000000"; | Chart Label Color, Default 000000 - do not include # |
Stock Chart
Historical chart example
<div id="chartdiv2" style="height:500px;"></div>
<script language="javascript" type="text/javascript" src="https://www.b2i.us/b2i/ChartApi_20.asp?v=1.0.8.3"></script>
<script language="javascript" type="text/javascript">
function LoadChart(){
oChart.BizID= "449";
oChart.Exchange= "NYSE: ";
oChart.sDiv = "chartdiv2";
oChart.Symbol = "EAT";
oChart.Period= "3";
oChart.Mode= "0";
oChart.FillColor = "336699";
oChart.CursorColor = "336699";
oChart.BGColor = "ffffff";
oChart.LeftMargin=40;
oChart.RightMargin=40;
GetChart();
}
if (window.addEventListener) {
window.addEventListener('load', LoadChart, false);
} else if (window.attachEvent) {
window.attachEvent('onload', LoadChart);
}
</script>
Intraday chart example
NOTICE: the intraday chart object is oiChart.
When adding parameters make sure to use the correct object name.
Ex: oiChart.SymbolDisplay="Optical Cable Corporation (OCC)";
<div id="chartintradiv" style="height:400px;"></div>
<script language="javascript" type="text/javascript" src="https://www.b2i.us/b2i/ChartIntraApi_20.asp?v=1.0.8.3"></script>
<script language="javascript" type="text/javascript">
function LoadIntraChart(){
oiChart.BizID="2626";
oiChart.sHttp="https";
oiChart.Dollar="0";
oiChart.DollarR="1";
oiChart.Exchange= "NYSE | ";
oiChart.sDiv = "chartintradiv";
oiChart.Symbol = "EAT";
oiChart.LeftMargin=40;
oiChart.RightMargin=40;
oiChart.GridAlpha = "0";
GetIntraChart();
}
if (window.addEventListener){
window.addEventListener('load', LoadIntraChart, false);
} else if (window.attachEvent){
window.attachEvent('onload', LoadIntraChart);
}
</script>
Candlestick chart example
<div id="chartdiv" style="height:500px;"></div>
<script language="javascript" type="text/javascript" src="https://www.b2i.us/b2i/ChartApi_20.asp?v=1.0.8.3"></script>
<script language="javascript" type="text/javascript">
function LoadCandleChart(){
oChart.BizID= "449";
oChart.sDiv = "chartdiv";
oChart.Mode="1"; // <- this makes it a candlestick chart
oChart.UpLineColor="336699",
oChart.UpFillColor="336699",
oChart.DownLineColor="ff0000",
oChart.DownFillColor="ff0000",
oChart.LineThickness= "1";
oChart.Exchange= "NYSE: ";
oChart.Symbol = "EAT";
oChart.Period= "3";
oChart.LeftMargin=40;
oChart.RightMargin=40;
oChart.FillColor = "336699";
oChart.CursorColor = "336699";
oChart.BGColor = "ffffff";
GetChart();
}
if (window.addEventListener) {
window.addEventListener('load', LoadCandleChart, false);
} else if (window.attachEvent) {
window.attachEvent('onload', LoadCandleChart);
}
</script>
| oChart.sDiv="chartdiv"; | Sets the location to render the data - when using multple on page may have to incrementally load using JS setTimeout() |
| oChart.Mode="1"; | Default oChart.Mode="0" for line & area chart - use oChart.Mode="1", for Candlestick chart |
| oChart.SymbolDisplay=""; | Override internal label text - great for setting the company name or any custom text |
| oChart.UpLineColor="336699"; oChart.UpFillColor="336699"; oChart.DownLineColor="ff0000"; oChart.DownFillColor="ff0000"; | Candle up / down indicatior colors - hex code no # |
| oChart.Dollar="0"; | Show currency sign on left, set to "1" for dollar, "2" for euro, "3" for £ - pound |
| oChart.DollarR=""; | Show currency sign on right, set to "1" for p - pound |
| Chart Type and Fill | |
| oChart.ChartType="line"; | Chart Type - options: line, smoothedLine, step, column |
| oChart.FillColor="336699"; | Chart Fill Color, Default 336699 - do not include # |
| oChart.FillAlpha=0.2; | Chart Fill Alpha, Default 0.2 - Set to 0 to turn off fill color for a line only |
| oChart.LineThickness= "4"; | Chart Line Thickness, Default 2 |
| Label Text | |
| oChart.SymbolDisplay=""; | Over ride symbol display - empty by default |
| oChart.PriceTitle="Price"; | Chart Price Title |
| oChart.VolumeTitle="Volume"; | Volume Chart Title |
| oChart.CloseText="Close"; | Close Text in bubble |
| oChart.VolumeText="Volume"; | Volume Text in bubble |
| oChart.SaveText="Save data as"; | Save text for saving chart data |
| oChart.AllText="ALL"; | Button for All |
| oChart.Lang="1"; | Language for months oChart.Lang="1"; //english oChart.Lang="2"; //spanish oChart.Lang="3"; //portuguese oChart.Lang="4"; //french |
| Label Formatting | |
| oChart.AxisLabelColor="666666"; | Axis Label Color, Default 666666 - do not include # |
| oChart.AxisLabelSize="11"; | Axis Label Size, Default "11" |
| oChart.ValueInsideChart=true; | For placement of data values - set to false for outside the chart - must also set left margin |
| oChart.LeftMargin="5"; | Set to higher value to allow values outside of chart - oChart.LeftMargin="60; |
| oChart.TopLabelColor="666666"; | Top Label Color, Default 666666 - do not include # |
| oChart.TopLabelSize=15; | Top Label Size, Default 15 |
| oChart.InsideLabelColor="336699"; | Inside Label Color, Default 336699 - do not include # |
| oChart.InsideLabelSize=25; | Inside Label Size, Default 25 |
| oChart.InsideLabelAlpha=0.3; | Inside Label Alpha, Default 0.3 - Set to 0 remove |
| Chart Background | |
| oChart.BGColor="ffffff"; | Chart Background Color, Default ffffff - do not include # |
| oChart.BGAlpha=1; | Chart Background Alpha, Default 1 - set to 0 for transparency or between 0 and .9 |
| oChart.UseDashGrid="1"; | Chart Use Dash Grid |
| oChart.GridAlpha=".2"; | Chart Grid Alpha |
| oChart.GridColor="bbbbbb"; | Chart Grid Color, Default bbbbbb - do not include # |
| Chart Border | |
| oChart.ChartBorderColor="999999"; | Chart Border Color, Default 999999 - do not include # |
| oChart.ChartBorderAlpha=".5"; | Chart Border Alpha, Default .5 - set to 0 for none |
| Cursor | |
| oChart.CursorShow=true; | Show Cursor - set to false to hide |
| oChart.CursorColor="336699"; | Cursor Color, Default 336699 - do not include # |
| oChart.CursorAlpha=".1"; | Cursor Alpha, Default ".1" - set 0 to 1 |
| Period Selector | |
| oChart.PeriodSelectorShow=1; | Show Period Selector - set to 0 to hide |
| oChart.PeriodSelectorLocation="bottom"; | Period Selector Location - options: bottom, top, left, right |
| oChart.Period="3"; | Chart time period to show - Default 3 for 3 months oChart.Period="1"; for 10 day oChart.Period="2"; for 1 month oChart.Period="3"; for 3 month oChart.Period="4"; for 6 month oChart.Period="5"; for 1 year oChart.Period="6"; for 5 year oChart.Period="7"; for All |
| Volume | |
| oChart.ShowVolumeChart=true; | Show Volume Chart - set to false to hide |
| oChart.VolumeChartType="column"; | Volume Chart Type - options: line, smoothedLine, step, column |
| oChart.VolumeFillAlpha=1; | Volume Chart Fill Alpha, Default 1 - set to 0 for transparency or between 0 and .9 |
| Balloon | |
| oChart.BalloonFillColor="ffffff"; | Balloon Fill Color, Default ffffff - do not include # |
| oChart.BalloonFontSize=13; | Balloon Font Size, Default 13 |
| Scroll Bar | |
| oChart.ShowScrollBar=true; | The bottom scroll window on chart - set to false to hide |
| Data Format / Separators | |
| oChart.Centseperator="."; | Decimal separator: oChart.Centseperator="."; |
| oChart.Numseperator=","; | Thousands separator: oChart.Numseperator=","; |
When using Duda CMS, there is a different implementation needed for adding the chart to the page since it does not implement the native JS DOM.
<div id="chartdiv" style="height:500px;"></div>
<script language="javascript" type="text/javascript" src="https://www.b2i.us/b2i/ChartApi_20.asp?v=1.0.8.3"></script>
<script language="javascript" type="text/javascript">
dmAPI.runOnReady(LoadChart());
function LoadChart(){
oChart.BizID= "449";
oChart.Exchange= "NYSE: ";
oChart.sDiv = "chartdiv";
oChart.Symbol = "EAT";
oChart.Period= "3";
oChart.FillColor = "336699";
oChart.CursorColor = "336699";
oChart.BGColor = "ffffff";
GetChart();
}
</script>
Stock Detail Historical
<div id="HistoricalDiv"></div>
<script language="JavaScript" src="https://www.b2i.us/b2i/HistoricalQuoteApi.asp?v=1.0.8.3" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
window.addEventListener('load', function() {
oHistoric.BizID="2626";
oHistoric.sDiv="HistoricalDiv"; //When using quote multiple times on same page, set unique div names
oHistoric.sKey="Sf6Ic9Gy8";
oHistoric.Symbol="OCC";
oHistoric.sHttp="https";
getHistoricalData();
});
</script>
| oHistoric.CSS="1"; | Set to 0 to turn off default css |
| oHistoric.sDiv="HistoricalDiv"; | Sets the location to render the data |
| oHistoric.Dollar="0"; | Show currency sign on left, set to "1" for dollar, "2" for euro, "3" for £ - pound |
| oHistoric.DollarR=""; | Show currency sign on right, set to "1" for p - pound |
| oHistoric.DecLen="2"; | Decimal places, Default is 2, dl=4 would show 4 places right of decimal |
| oHistoric.DateFormat="0"; | Custom date format
0: 11/19/2020 1: Nov 19, 2020 2: 11/19/20 3: 19/11/2020 4: 19 Nov 2020 5: Tuesday, November 19, 2020 6: November 19, 2020 |
| oHistoric.Lang="1"; | Language of Labels, Default is 1 for english
1: English 2: Spanish 3: Portuguese 4: French 5: German 6: Italian |
| oHistoric.Centseperator=""; | Cents seperator override - example: oHistoric.Centseperator=","; |
| oHistoric.Numseperator=""; | Number seperator override - example: oHistoric.Numseperator="."; |
Stock Dividends
This data feed must be requested.
<div id="DividendsDiv"></div>
<script language="JavaScript" src="https://www.b2i.us/b2i/Dividendsapi.asp?v=1.0.8.3" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
window.addEventListener('load', function() {
oDividends.BizID="2626";
oDividends.sKey="Sf6Ic9Gy8";
oDividends.Symbol="OCC"; // Stock ticker that has dividends - service will need to be activated for your license
oDividends.sHttp="https";
getDividendsData();
});
</script>
| oDividends.DecLen="1"; | Decimal length, set to dl=1, Must be integer. Default is 0 / off |
| oDividends.Dollar="0"; | Show dollar sign, set to d=1, Default is 0 / off |
| oDividends.CSS="1"; | Set to 0 to turn off default css |
Analyst
This plugin is managed in the IR Office Portal.
<div id="AnalystDiv"></div>
<script language="JavaScript" src="https://www.b2i.us/b2i/AnalystApi.asp?v=1.0.8.3" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
window.addEventListener('load', function() {
oAnalyst.BizID="2626";
oAnalyst.sKey="Sf6Ic9Gy8";
oAnalyst.sHttp="https";
getAnalystData();
});
</script>
Events
This data is managed in our IR Office Portal.
<div id="CalDiv"></div>
<script language="JavaScript" src="https://www.b2i.us/b2i/Calapi.asp?v=1.0.8.3" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
window.addEventListener('load', function() {
oCal.BizID="2626";
oCal.sKey="Sf6Ic9Gy8";
oCal.sDiv="CalDiv"; //When using Calendar multiple times on same page, set unique div names
oCal.Mode="0"; //for all events, see below for other options
oCal.sHttp="https";
getCalData();
});
</script>
| oCal.Count="5"; | Count of items to show, default is 5 |
| oCal.Mode=""; | oCal.Mode="" for Future events only, oCal.Mode="1" for Past events, oCal.Mode="0" for all events |
| oCal.lo="2"; | Calendar List layout - default: lo="1"; currently 0-8 available |
| oCal.ViewLink="/yourpagename"; | The View link is used to display the Event in Full on a separate page. Add the link in this ViewLink parameter value. |
| oCal.Year="2017"; | Enter a year for segmenting data by years. |
| oCal.iDateFormat="1"; | Date Format: 1-6, default is 1, 1= mmm dd, yyyy 2= mm/dd/yyyy 3= dd/mm/yyyy 4= dd mmm yyyy 5= Day, Month dd, yyyy, 6= Month dd,yyyy |
| oCal.iDateLocation="1"; | default: 0, 1 for above title, 0 for below title |
| oCal.sDiv=""; | Sets the location to render the data. Use different div names when using the plugin on a page multiple times ex. Future Events and Past Events |
Event Viewer
This plugin is managed in the IR Office Portal.
<div id="CalViewDiv"></div>
<script language="JavaScript" src="https://www.b2i.us/b2i/CalViewapi.asp?v=1.0.8.3" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
window.addEventListener('load', function() {
oCalView.BizID="2626";
oCalView.sKey="Sf6Ic9Gy8";
oCalView.sDiv="CalViewDiv";
oCalView.sHttp="https";
oCalView.lo="2";
getCalViewData();
});
</script>
| oCalView.iDateFormat="1"; | Date Format: 1-6, default is 1, 1= mmm dd, yyyy 2= mm/dd/yyyy 3= dd/mm/yyyy 4= dd mmm yyyy 5= Day, Month dd, yyyy, 6= Month dd,yyyy |
Committee Composition
This plugin requires data to be entered into the B2i CMS
<div id="CommDiv"></div>
<script language="JavaScript" src="https://www.b2i.us/b2i/Commapi.asp?v=1.0.8.3" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
window.addEventListener('load', function() {
oComm.BizID="2626";
oComm.sKey="Sf6Ic9Gy8";
oComm.sHttp="https";
getCommData();
});
</script>
Custom images can be selected in the IR Office Portal.
Directors, Management, Advisors, etc.
This plugin is managed in the IR Office Portal. Many layouts are available for Directors, Management, Advisors etc.
<div id="DirDiv"></div>
<script language="JavaScript" src="https://www.b2i.us/b2i/DirectorApi.asp?v=1.0.8.3" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
window.addEventListener('load', function() {
oDir.BizID="2626";
oDir.sKey="Sf6Ic9Gy8";
oDir.sHttp="https";
oDir.lo="0"
getDirData();
});
</script>
| oDir.lo="0"; | Database driven templates for unlimited layouts |
| oDir.Group=""; | Groups used for Directors, Management, Advisors, etc. These are configured in our portal. |
| oDir.ViewLink=""; | URL Page Link that has View Module installed. |
| oDir.sOpen="1"; | Holds biography container open, removing collapsibility for layouts where implemented. |
Directors, Management, Advisors Viewer
This plugin is used in conjunction with the Dirtectors plugin and managed in the IR Office Portal.
<div id="DirViewDiv"></div>
<script language="JavaScript" src="https://www.b2i.us/b2i/DirectorViewApi.asp?v=1.0.8.3" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
window.addEventListener('load', function() {
oDirView.BizID="2626";
oDirView.sKey="Sf6Ic9Gy8";
oDirView.sHttp="https";
getDirViewData();
});
</script>
| oDirView.lo="1"; | Database driven templates for unlimited layouts |
Contact Us
<div id="ContactDiv"></div>
<script language="JavaScript" src="https://www.b2i.us/b2i/Contactapi2.asp?v=1.0.8.3" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
window.addEventListener('load', function() {
oContact.BizID="2626";
oContact.sKey="Sf6Ic9Gy8";
oContact.sHttp="https";
getContactData();
});
</script>
Request Info
<div id="RequestDiv"></div>
<script language="JavaScript" src="https://www.b2i.us/b2i/Requestapi2.asp?v=1.0.8.3" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
window.addEventListener('load', function() {
oRequest.BizID="2626";
oRequest.sKey="Sf6Ic9Gy8";
oRequest.sHttp="https";
getRequestData();
});
</script>
Documents List / Showcase
Basic usage
This plugin is managed in the IR Office Portal.
When using multiple times on the page, make sure to set a unique name with the sDiv parameter.
This parameter controls where the data loads by settings the container ID.
Make sure to include the container on the page.
<div id="ShowDiv"></div>
<script language="javascript" type="text/javascript" src="https://www.b2i.us/b2i/Showapi.js?v=1.0.8.3"></script>
<script language="javascript" type="text/javascript">
window.addEventListener('load', function() {
oShow.BizID="2626";
oShow.sKey="Sf6Ic9Gy8";
oShow.ID="110";
oShow.sDiv="ShowDiv";
oShow.sHttp="https";
oShow.si="2";
oShow.sd="0";
getShowData();
});
</script>
| oShow.sHttp="https"; | |
| oShow.lo="0"; | Layout: lo="0" table, lo="1" display LI, lo="2" display DIV, lo="3" for Div with Button, and others layout range 0-9 (10/30/21) |
| oShow.c="5"; | Count: c="5" how many items are displayed per page, default is 5 |
| oShow.n="0"; | Paging Navigation: n="0" Nav Off, n="1" Nav On |
| oShow.si="1"; | Show Image: si="0" No, si="1" Left, si="2" Right |
| oShow.sd="1"; | Show Date: sd="0" No, sd="1" 6/18/2020, sd="2" Jun 18, 2020, sd="3" June 18, 2020, sd="4" 18 / 06, sd="5" 18/06/2020, sd="6" 18 Jun 2020 |
| oShow.ds="0"; | Data Sort: ds="0" Date Desc, ds="1" Date Asc, ds="2" Title |
| oShow.sh="1"; | Show Header row: sh="0" No, sh="1" displays a row with Date, Title headings |
| oShow.tl="1"; | Show Year Drop down: tl="0" No, tl="1" yes |
| oShow.CSS="1"; | Default CSS: CSS="0" No, CSS="1" yes - default CSS="1" |
| oShow.iStoryWidth="600"; | Content floating div width reduced size: default 600 px |
| oShow.iStoryHeight="600"; | Content floating div height reduced size: default 600 px |
| oShow.iStoryMaxWidth=""; | Content floating div width expanded size: default screen size -80 px |
| oShow.iStoryMaxHeight=""; | Content floating div height expanded size: default screen size -80 px |
| oShow.iLeftOffset="0"; | Content floating div offset from left: default 0 |
| oShow.iTopOffset="0"; | Content floating div offset from top: default 0 |
Earnings Banner / Custom Code
Basic usage
This plugin is managed in the IR Office Portal. This module allows any code or text to be entered and used anywhere. This module can be schedule to display and hide by date / time.
<div id="CodeDiv"></div>
<script language="JavaScript" src="https://www.b2i.us/b2i/CodeApi.asp?v=1.0.8.3" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
window.addEventListener('load', function() {
oCode.BizID="2626";
oCode.sKey="Sf6Ic9Gy8";
oCode.sDiv="CodeDiv";
oCode.id="19420";
getCodeData();
});
</script>
Quarterly Info / Accordion Page Content / Multi-Section Downloads Plugin API
Basic usage
This plugin is managed in the IR Office Portal.
<div id="PageDiv"></div>
<script language="JavaScript" src="https://www.b2i.us/b2i/Pageapi.js?v=1.0.8.3" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
window.addEventListener('load', function() {
oPage.BizID="2626";
oPage.sKey="Sf6Ic9Gy8";
oPage.sHttp="https";
oPage.id="16458";
getPageData();
});
</script>
| oPage.SectionCount="1"; | Count of sections to return: default "" |
| oPage.lo="2"; | Layout: default "1" |
| oPage.SectionsOpen="1"; | Count of sections to have open on load: default "" |
| oPage.IgnoreHeaders="1"; | Makes plugin not write the header Divs: default "" |
| oPage.CSS="1"; | Use default CSS: 0:no 1:yes - default "1" |
| oPage.iStoryWidth="600"; | Content floating div width reduced size: default 600 px |
| oPage.iStoryHeight="600"; | Content floating div height reduced size: default 600 px |
| oPage.iStoryMaxWidth=""; | Content floating div width expanded size: default screen size -80 px |
| oPage.iStoryMaxHeight=""; | Content floating div height expanded size: default screen size -80 px |
| oPage.iLeftOffset="0"; | Content floating div offset from left: default 0 |
| oPage.iTopOffset="0"; | Content floating div offset from top: default 0 |