Q4Widgets API Documentation

q4.institutionalOwnershipIndex

The Ownership Index widget is used to display data elements related to institutions & funds. Templated for index sites.
Script link
q4.studioApi.4.0.0.min.js
Source file
q4.studioApi.js, line 2752

This widget extends the q4.institutionalOwnership widget. It has all the options and methods of the parent widget, in addition to those below. See the parent widget's documentation for details.

Examples

<script type="text/javascript">
    $('.ownership-widget').institutionalOwnershipIndex()
</script>

Options

summarySelector string
A selector where the summary table will be rendered
Default value
.irwInstitutionalOwnershipDivTable
totalTabsSelector string
A selector where the tabs will be rendered
Default value
.irwInstitutionalOwnTabs
totalDropdownSelector string
A dropdown replacement for the tabs while on tablet
Default value
.irwInstitutionalOwnershipResponsiveTabs
detailsSelector string
A selector where the details will be rendered
Default value
.irwInstitutionalOwnContent
ownershipTypeSelector string
A selector for the ownership type dropdown
Default value
.irwInstitutionalOwnSelect
activityTypeSelector string
Text to describe which tab is selected
Default value
.InstitutionalOwnershipView
totalCountSelector string
A selector which will be updated to the total number of items
Default value
#recordCount
firstRecordSelector string
A selector which will be updated to the first index of the current page
Default value
#pageFirstRecord
lastRecordSelector string
A selector which will be updated to the last index of the current page
Default value
#pageLastRecord
totalTabActiveCls string
A class which is applied to the active tab.
Default value
active
totalTabInactiveSelector string
A selector which targets an inactive tab.
Default value
.irwInstOwnNoLink
dropdownToggleSelector string
A selector which targets the dropdown toggle.
Default value
.dropdown-toggle
dropdownSelector string
A selector for the dropdown.
Default value
.irwCustomDropDown
dropdownItemSelector string
A selector for the dropdown item.
Default value
.irwCustomDropDownItem
dropdownSelectedItemSelector string
A selector for the selected dropdown selector.
Default value
.irwCustomDropDownSelected
dropdownOpenCls string
A class which is applied when the dropdown is open. Class is removed when option is selected.
Default value
open
headers function
A mapping object for the table headers. 'type' parameter is taken from the options under 'ownershipTypeSelector' option. 
headers: function (type) {
   return [{
       label: type === 'institution' ? 'Company' : 'Fund',
       fieldName: 'ownerName',
       cls: 'Tbl-th-FirstCol text-primary InstitOwnSorting',
   }, {
       label: 'Shares',
       fieldName: 'sharesHeld',
       cls: 'text-center text-primary InstitOwnSorting',
       sortBy: true
   }, {
       label: '% Out',
       fieldName: 'outprcnt',
       cls: 'text-center text-primary InstitOwnSorting'
   }, {
       label: 'Value ($)',
       fieldName: 'valuation',
       cls: 'text-right text-primary InstitOwnSorting'
   }, {
       label: 'Reported',
       fieldName: 'reported',
       cls: 'text-left text-primary InstitOwnSorting',
       breakpoints: 'xs sm'
   }, {
       label: 'Change',
       fieldName: 'sharesChanged',
       cls: 'text-right text-primary InstitOwnSorting',
       breakpoints: 'xs sm'
   }]
},
loadingMessage string
A message or HTML string to display while first loading the widget.
Default value
<p class="module_loader">Loading ...</p>
template string
Default template for out of the box use 
'<div class="InstitutionalOwnershipForm" style="display:none;">' +
     '<div class="container InsiderOwnership">' +
         '<h1 class="InsiderOwnershipHeading irwTitle">Institutional Ownership</h1>' +
         '<div id="InstitutionalOwnershipPanel">' +
             '<div class="irwDivTable col-xs-12 irwInstitutionalOwnershipDivTable"></div>' +
             '<div class="clearfix"></div>' +
             '<div class="irwDivTable col-xs-12">' +
                 '<div class="row bg-primary irwDivTableHeader InstitutionalOwnershipTitle2">' +
                     '<strong>Ownership Activity - <span class="InstitutionalOwnershipView">Total Positions</span></strong>' +
                 '</div>' +
             '</div>' +
             '<div class="clearfix"></div>' +
             '<div class="row visible-sm visible-xs clear irwInstitutionalOwnershipResponsiveTabs"></div>' +
             '<ul class="nav nav-pills nav-stacked irwCommonTabs col-md-3 irwInstitutionalOwnTabs visible-md visible-lg"></ul>' +
             '<div class="tab-content col-md-9 irwInstitutionalOwnTabsContent">' +
                 '<div class="tab-pane active HasCustomFields irwInstOwnLoading">' +
                     '<div class="row">' +
                         '<div class="col-md-6">' +
                             '<select id="keyFndg" class="irwInstitutionalOwnSelect form-control security Customform-group">' +
                                 '<option value="institution" selected="">Institutional Ownership</option>' +
                                 '<option value="mutualfund">Mutual Fund</option>' +
                             '</select>' +
                         '</div>' +
                         '<div class="col-md-6"></div>' +
                     '</div>' +
                 '</div>' +
                 '<div class="row irwInstOwnLoading irwInstOwnTblPannel">' +
                     '<div class="col-md-12 irwInstitutionalOwnContent"></div>' +
                 '</div>' +
                 '<div class="clearfix"></div>' +
                 '<div class="irwTableFooter">' +
                     '<div class="row">' +
                         '<div class="col-xs-12 col-sm-4 col-md-4">' +
                             '<div class="irwpagedisplay">' +
                                 'Displaying 1 to 20 (of )' +
                             '</div>' +
                         '</div>' +
                         '<div class="col-xs-12 col-sm-8 col-md-8">' +
                             '<div class="irwInstitutionalOwnPagination pull-right"></div>' +
                         '</div>' +
                     '</div>' +
                 '</div>' +
             '</div>' +
         '</div>' +
     '</div>' +
 '</div>'
summaryTpl string
Template to be used for Ownership Information 
'<div class="row bg-primary irwDivTableHeader InstitutionalOwnershipTitle1">' +
    '<strong>Ownership Information</strong>' +
'</div>' +
'{{#.}}' +
    '<div class="row irwDivTableRow text-primary">' +
        '<div class="col-xs-6">' +
            '<span>{{label}}</span>' +
        '</div>' +
        '<div class="col-xs-6 text-right">' +
            '<span>{{value}}</span>' +
        '</div>' +
    '</div>' +
'{{/.}}'
totalTabsTpl string
Template to be used for tabs. Only supports the use of html 'li' html tag 
'{{#.}}' +
    '{{#holders}}<li class="text-primary InstitOwnTab" data-type="{{label}}"><a href="#" data-toggle="pill">{{/holders}}' +
    '{{^holders}}<li class="irwInstOwnNoLink"><a data-toggle="pill">{{/holders}}' +
    '<h4>{{name}}</h4>' +
    '{{#holders}}' +
        '<small class="text-muted tabMuteTitle  hidden-xs">' +
            'HOLDERS' +
        '</small>' +
        '<small class="text-muted hidden-xs pull-left">' +
            '<strong>{{holders}}</strong>' +
        '</small>' +
        '<div class="clearfix"></div>' +
    '{{/holders}}' +
    '{{#shares}}' +
        '<small class="text-muted hidden-xs tabMuteTitle">' +
            'SHARES' +
        '</small>' +
        '<small class="text-muted hidden-xs pull-left">' +
            '<strong>{{shares}}</strong>' +
        '</small>' +
        '<div class="clearfix"></div>' +
    '{{/shares}}' +
    '</a>' +
    '<div class="irwVerTabsConnect"></div>' +
'</li>{{/.}}'
totalDropDownTpl string
A dropdown version of the totals for matching mobile 
'<div class="col-md-12">' +
    '<div class="well" style="overflow: visible;">' +
        '<div class="btn-group btn-input clearfix irwCustomDropDown">' +
            '<button type="button" class="btn btn-default dropdown-toggle form-control btn-block" data-toggle="dropdown" aria-expanded="false">' +
                '<span class="irwCustomDropDownSelected" data-bind="label">Total Positions</span>' +
                '<span class="caretContainer"> <span class="caret"></span></span>' +
            '</button>' +
            '<ul class="dropdown-menu text-primary instOwnerCustomDropDown" role="menu">' +
                '{{#.}}' +
                '{{#holders}}<li data-type="{{label}}">{{/holders}}' +
                    '{{^holders}}<li class="irwInstOwnNoLink">{{/holders}}' +
                    '<a class="InstitOwnTab">' +
                        '<span class="irwCustomDropDownItem">{{name}}</span>' +
                        '<div class="clearfix"></div>' +
                        '{{#holders}}' +
                        '<small class="text-muted tabMuteTitle">HOLDERS</small>' +
                        '<small class="text-muted "><strong>{{holders}}</strong></small>' +
                        '{{/holders}}' +
                        '{{#shares}}' +
                        '<small class="text-muted tabMuteTitle">SHARES</small>' +
                        '<small class="text-muted"><strong>{{shares}}</strong></small>' +
                        '{{/shares}}' +
                    '</a>' +
                '</li>' +
                '{{/.}}' +
            '</ul>' +
        '</div>' +
    '</div>' +
'</div>'
tableTpl string
Template to be used for the details table 
'<table class="table Tbl-InsitOwnership irwResponsiveTable table-hover" data-sort="false">' +
    '<thead>' +
        '<tr>' +
            '{{#headers}}' +
                '<th role="button" class="{{cls}}{{#sortBy}} descending{{/sortBy}}" data-sort="{{#sortBy}}true{{/sortBy}}{{^sortBy}}false{{/sortBy}}" data-order="-1" data-field="{{fieldName}}" {{#breakpoints}}data-breakpoints="xs sm"{{/breakpoints}}>{{label}}</th>' +
            '{{/headers}}' +
        '</tr>' +
    '</thead>' +
    '<tbody></tbody>' +
'</table>'
tableBodyTpl string
Template for the details body to allow for refreshing data without rerendering the entire table 
'{{#data}}' +
    '<tr class="text-primary">' +
        '<td class="text-left"><span>{{ownerName}}</span></td>' +
        '<td class="text-center"><span>{{sharesHeld}}</span></td>' +
        '<td class="text-center"><span>{{outprcnt}}</span></td>' +
        '<td class="text-right"><span>{{valuation}}</span></td>' +
        '<td class="text-left"><span>{{reported}}</span></td>' +
        '<td class="text-right"><span>{{sharesChanged}}</span></td>' +
    '</tr>' +
'{{/data}}'
copyrightDisclaimerTpl string
The template for the copyright disclaimer's popup 

'<div id="irwWrapper" style="margin:0;padding:0;">' +
  '<div class="modal-dialog" style="margin:0;padding:0">' +
      '<div class="modal-content">' +
          '<div class="modal-header bg-primary">' +
              '<h4 class="modal-title"><strong id="ModelTitle">Copyright Information</strong></h4>' +
          '</div>' +
          '<div class="modal-body">' +
              '<div id="PopupDive" class="irwScrollbar mCustomScrollbar _mCS_1 _mCS_4" style="max-height: 260px; overflow: hidden;" aria-hidden="true">' +
                  '<div class="mCustomScrollBox mCS-bootstrap-thin" id="mCSB_4" style="position: relative; height: 100%; overflow: hidden; max-width: 100%; max-height: 260px;">' +
                      '<div class="mCSB_container mCS_no_scrollbar" style="position:relative; top:0;">' +
                          '<div>' +
                              'Copyright © 2020, S&P Global Market Intelligence (and its affiliates as applicable). ' +
                              'Reproduction of any information, opinions, views, data or material, including ratings (“Content”) in any form is prohibited except with the prior written permission of the relevant party. ' +
                              'Such party, its affiliates and suppliers (“Content Providers”) do not guarantee the accuracy, adequacy, completeness, timeliness or availability of any Content and are not responsible for any errors or omissions (negligent or otherwise), regardless of the cause, or for the results obtained from the use of such Content. ' +
                              'In no event shall Content Providers be liable for any damages, costs, expenses, legal fees, or losses (including lost income or lost profit and opportunity costs) in connection with any use of the Content. ' +
                              'A reference to a particular investment or security, a rating or any observation concerning an investment that is part of the Content is not a recommendation to buy, sell or hold such investment or security, does not address the suitability of an investment or security and should not be relied on as investment advice. ' +
                              'Credit ratings are statements of opinions and are not statements of fact.' +
                          '</div>' +
                      '</div>' +
                  '</div>' +
              '</div>' +
          '</div>' +
      '</div>' +
  '</div>' +
'</div>'