Script link

q4.studioApi.3.0.0.min.js

Source file

q4.studioApi.js, line 7225

This widget extends the q4.studioApi 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

<div class="regfilings_widget"></div>
<script>
$('.regfilings_widget').regFilings({
    studioApi: "", 
    ticker: "",
    itemsPerPage: 5,
    paginationSelector: ".regfilings_pager"
});
</script>

Options

institutionId string

The SNL institution of the company. If ticker is not used then the value provided for this option will be used.

defaultTemplate string

Default template for out of the box use.

'<div class="regfilings_filters-container">' +
    '<select class="regfilings_filter regfilings_filter--years"></select>'+
    '<select class="regfilings_filter regfilings_filter--documents"></select>'+
    '<select class="regfilings_filter regfilings_filter--company"></select>'+
    '</div>'+
'<div class="regfilings_results-container"></div>'+
'<div class="regfilings_pager"></div>'

filingsTpl string

The template for the table of filings.

'<table class="table table--responsive regFilings_table">'+
'<thead>'+
    '<tr>'+
        '<th class="regFilings_header-col--description">Filing Description</th>'+
        '<th class="regFilings_header-col--type">Filing Type</th>'+
        '<th class="regFilings_header-col--filing-date">Filing Date</th>'+
        '<th class="regFilings_header-col--event-date">Event Date</th>'+
        '<th class="regFilings_header-col--download">Download</th>'+
    '</tr>'+
'</thead>'+
'<tbody>'+ 
'{{#items}}'+
    '<tr class="regFilings_row {{#filingAbstract}}regFilings_row--hasAbstract{{/filingAbstract}}">'+
        '<td data-heading="Filing Description">'+
            '<a href="{{linkToDetailsPage}}" target="_blank">{{filingDescription}}</a>'+
        '</td>'+
        '<td data-heading="Filing Type">{{filingTypeMnemonic}}</td>'+
        '<td data-heading="Filing Date">{{filingDate}}</td>'+
        '<td data-heading="Event Date">{{eventDate}}</td>'+
        '<td data-heading="Download">'+
            '{{#documents}}'+
                '<a href="{{url}}" target="_blank" class="regFilings_download-item q4icons_icon"  aria-label="Filing {{filingTypeMnemonic}} dated {{filingDate}} in {{documentType}} format">'+
                    '<span class="sr-only">{{documentType}} (Opens in a new Window)</span>'+
                '</a>'+
            '{{/documents}}'+
        '</td>'+
    '</tr>'+
    '{{#filingAbstract}}'+
    '<tr class="regFilings_row--abstract">'+
        '<td colspan="5" data-heading="Abstract"><strong>Abstract:</strong> {{filingAbstract}}</td>'+
    '</tr>'+
    '{{/filingAbstract}}'+
'{{/items}}'+
'</tbody>'+ 
'</table>'

filingsResultsContainer string

The selector for where the filingsTpl should be rendered

Default value

.regfilings_results-container

paginationTpl string

The template for the pagination

paginationTrigger string

A selector for each element that will trigger the pagination's on click event.

Default value

li

pageRange number

The number of pages to show at one time. Recommend using odd numbers. Adds "pager-hide" and "js--hidden" classes to all items that should be hidden.

Default value

null

Example

5

itemsPerPage number

The number of items to render per page. If a value is given the widget will use it's built-in pagination feature.

Default value

0

filters Array.<object>

An array of filter configurations for filtering the data.
Each object in the array must contain the following fields:

• type: This value should be the corresponding field in the GET Filters request (see Studio Public API)
• selector: Where this filter should be rendered
• tpl: template for the filter

Default:

[
    {
    type: "years",
    selector: ".regfilings_filter--years", 
    tpl: (
        '<option value="">All Years</option>'+
        '{{#.}}'+
            '<option value="{{.}}">{{.}}</option>'+
        '{{/.}}'
    )}, {
    type: "documentTypes",
    selector: ".regfilings_filter--documents", 
    tpl: (
        '<option value="">All Documents</option>'+
        '{{#.}}'+
            '<option value="{{.}}">{{.}}</option>'+
        '{{/.}}'
    )} , {
     type: "companies",
     selector: ".regfilings_filter--company", 
     tpl: (
         'All Companies'+
         '{{#.}}'+
             '{{name}}'+
         '{{/.}}'
     )}
]

docTypes object

A mapping which is used to replace the value of a document's documentType.

Default value

{ 'CONVPDF': 'PDF' }

downloadsContainer string

A selector for the container of the downloadable documents section.

Default value

.regFilings_downloads

downloadsTrigger string

A selector for the trigger to reveal downloadsContent when clicked.

Default value

.regFilings_download-trigger

downloadsContent string

A selector for the section that gets revealed when downloadsTrigger is clicked.

Default value

.regFilings_download-div

downloadsToggleCls string

The class applied when the downloadsTrigger is clicked.

Default value

js--active

noFilingsFoundMsg string

A message or HTML string to display in the filingsResultsContainer if no filings are found.

Default value

<p class="regFilings_no-filings">No Filings Found</p>

beforeRerender function

A callback that fires before the full widget is rerendered due to a change in page, sorting or filtering. It is generally used to restructure/manipulate data before being passed into the filingsTpl, paginationTpl and filter templates (see filters option).

Parameters

event Event

The event object.

data Object

The data object.

rerenderComplete function

A callback function that fires after widget rerenders due to a change in page, sorting or filtering.

Parameters

event function

A callback function that fires after widget rerenders due to a change in page, sorting or filtering.