V1
Viewer ActiveReportsJS Class

Viewer Class

Report viewer component.

Hierarchy

  • Viewer

Constructors

constructor

  • new Viewer(element: any, options?: any): Viewer
  • Creates the viewer within container element (div) with id='viewer' and sets the language:

     var options = { language: 'ru' };
     var viewer = new ActiveReports.Viewer('#viewer', options );
     viewer.open('report.json');

    Parameters

    • element: any

      Where to render the viewer control. Accepts on of the following values:

      • string: DOM selector of the element to render viewer to. E.g. '#viewer'
      • DOM Element. E.g. document.getElementById('viewer')
      • JQuery object. E.g. $('#viewer')
    • Optional options: any

      control settings. Accepts the object with the following optional fields:

      • language - language key. Localization bundle must be loaded in page's script block
      • ErrorHandler - Function for custom error handling (see errorHandler below)
      • ReportName - specifies the report to open.
      • ReportParams - specify report parameters to set before preview. Report Parameters is an array of object e.g.[{ Name: 'parameter1', Value: ['paramValue'] }]

    Returns Viewer

Properties

availableExports

availableExports: string[]

Set exports which should be displayed in export panel when export plugins attached to viewer.

viewer.availableExports = [''] //disable all loaded export modules
viewer.availableExports = ['pdf'] //filters out any export formats other than PDF
viewer.availableExports = [] //enable all loaded export modules

currentPage

currentPage: number

Gets current page number (1-based). Returns 0 if no document loaded.

var pageNumber = viewer.currentPage;

documentLoaded

Set and register documentLoaded event which occurs once document is fully rendered in viewer. Also works on refresh.

type DocumentLoadedEventArgs = {
    pageCount: number;
    cancelled?: boolean;
}

viewer.documentLoaded.register(args => console.log('Report was fully rendered ', args));

errorHandler

errorHandler: PluginModel.ErrorHandler

Gets or sets error handler for viewer. Allow user to override existing and not to show error pane if user wants to customize error output.

type ErrorMessage = {
    severity: "error" | "warn" | "info" | "debug";
    message: string,
    details: string);

function handler(error: ErrorMessage){
    console.log(error.message);
    return true; // return true if you don't want to show this error in viewer's error pane
}


viewer.errorHandler = handler;

history

history: HistoryApi

Provides access to the "history" API.

mouseMode

mouseMode: ViewerMouseMode

Gets or sets mouse mode in viewer. Available values are: Pan | Selection.

viewer.mouseMode = "pan";

pageCount

pageCount: number

Gets the total number of pages available in report.

var totalPages = viewer.pageCount;

renderMode

renderMode: ViewerRenderMode

Gets or sets viewer render mode. Available values are: Galley | Paginated

viewer.renderMode = 'Galley';

reportLoaded

Set and register reportLoaded event which occurs once report is loaded in viewer. Doesn't account for drill through reports.

 type ReportLoadedEventArgs = {
    reportSource: string | RDLReportDefinition;
    parameters: ParameterDescriptor[];
}


viewer.reportLoaded.register(args => console.log('Report just loaded ', args));

stateChanged

stateChanged: EventFan<ChangedEventArgs>

Gets the event indicating the viewer state is changed. The changes include visual settings and content change such as rendering document.

toolbar

toolbar: Toolbar

Gets the viewer toolbar component.

viewMode

viewMode: ViewerViewMode | ViewMode

Gets or sets viewer viewMode.

enum ViewMode {
    SinglePage = 0,
    ContinousPage = 1
}
var viewMode = viewer.viewMode //by default SinglePage
//set to continous
viewer.viewMode = 'continuous' // or viewer.viewMode = 1;

zoom

Gets or sets current zoom value. Zoom value could be specified as factor. Valid values:

  • from 0 up to 3 where 0.5 indicate 50% and 3 = 300%;
  • const values 'FitToWidth' | 'FitPage' (case insensitive)
var currentZoom = viewer.zoom; //by default 1 (100%)
//now set mode to Fit to Width
viewer.zoom = 'FitToWidth';
//now verify value
var newValue = viewer.zoom;
//newValue will be equal to FitToWidth

Methods

backToParent

  • backToParent(): void
  • Performs backToParent action which will return user to parent report.

    viewer.backToParent();

    Returns void

canBackToParent

  • canBackToParent(): boolean
  • Gets true if backToParent command is applicable to current document.

    Returns boolean

dispose

  • dispose(): void
  • Removes the control from the DOM and disposes any resources (internal).

    Returns void

export

  • export(format: string, settings: any[], params?: undefined | object): Promise<ExportResult>
  • Exports currently displayed report to specified output format. Returns object which contains result data as blob object | string and download function. So you could either use this blob object or download file immediately. Please note that you can specify settings in PDF export as plain list (like {title: 'Title', author: 'Author Name', ownerPassword: '1'} etc...

    var options = {filename:"Invoice List"};
    var cancelCallback = function(){
        return false; // continue export. Return true to cancel export process
    }
    viewer.export('pdf', options, {cancel: cancelCallback }).then(result => doSmthWithBlob(result.data));
    //or you can download file
    viewer.export('pdf', options, {cancel: cancelCallback }).then(result => result.download('Invoice List'));

    Parameters

    • format: string

      Export format identifier. One of 'pdf', 'xlsx' or 'html'.

    • settings: any[]

      Format specific export settings.

    • Optional params: undefined | object

      Additional export customization.

    Returns Promise<ExportResult>

goToFirstPage

  • goToFirstPage(): void
  • Navigates to the first page.

    viewer.goToFirstPage();

    Returns void

goToLastPage

  • goToLastPage(): void
  • Navigates to the last page.

    viewer.goToLastPage();

    Returns void

goToNextPage

  • goToNextPage(): void
  • Navigates to the next page.

    viewer.goToNextPage();

    Returns void

goToPage

  • goToPage(pageNumber: number): void
  • Navigates to the specified page (starting from 1).

    viewer.goToPage(3); //will navigate to 3d page

    Parameters

    • pageNumber: number

    Returns void

goToPrevPage

  • goToPrevPage(): void
  • Navigates to the previous page.

    viewer.goToPrevPage();

    Returns void

highlight

  • Highlights the search result returned by a search method.

    results = [];
    
    
    function search(text){
        viewer.search({text}, function(result){
            results.push(result)
        }).then(function(status){
            console.log(status)
        })
    }
    
    
    function nextSearchResult(index){
        if(results.length == 0){
            viewer.highlight(null);
            return;
        }
        viewer.hightlight(resutls[index]);
    }

    Parameters

    Returns Promise<void>

open

  • Opens report from file or as definition (json string)).

    var viewer = new ActiveReports.Viewer(#viewerPlace);
    viewer.open('report.json');

    Parameters

    • report: string | RDLReportDefinition | PageReport

      The report template. Can be report URI, or report definition, or instance of PageReport class.

    • Optional settings: Partial<ReportSettings>

      Additional settings for report (name, parameters).

    Returns Promise<LoadResult>

print

  • print(): void
  • Prints currently displayed report.

    viewer.print();

    Returns void

refresh

  • refresh(): void
  • Performs refresh operation in report (re-render report).

    viewer.refresh();

    Returns void

registerFont

  • registerFont(...fonts: FontDescriptor[]): void
  • For PDF export only. Register specified fonts in pdf export. Helps display export correctly on machines where fonts can be missed.

    type FontDescriptor = {
        name: string,
        source: string,
        weight?: 'normal' | 'bold' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900',
        style?: 'normal' | 'italic' | 'oblique'
    }
    
    
    var arial = {
        name: 'Arial',
        source: 'fonts/arial.ttf',
        style: 'italic',
        weight: '700',
    };
    
    
    var gothic = {
        name: 'MS PGothic',
        source: 'fonts/MS-PGothic.ttf'
    };
    
    
    viewer.registerFont(arial);
    //OR
    viewer.registerFont(arial, gothic);
    //OR
    var fonts = [arial, gothic]; viewer.registerFont(...fonts);

    Parameters

    • Rest ...fonts: FontDescriptor[]

    Returns void

search

  • Performs search operation in currently rendered report. Allows you to create your own custom search pane.

    viewer.search({
        text: "Ship",
        matchCase: true
    }, function(result){
        console.log(result)
    }, function(progress){
        console.log(progress)
    })

    Parameters

    Returns Promise<SearchStatus>

toggleFullScreen

  • toggleFullScreen(enabled?: undefined | false | true): void
  • Change viewer mode to fullscreen.

    viewer.toggleFullScreen();

    Parameters

    • Optional enabled: undefined | false | true

    Returns void

toggleSidebar

  • toggleSidebar(visible?: undefined | false | true): void
  • Toggle sidebar panel(hide or show it). In case if no parameter passed works as toggle.

    viewer.toggleSidebar(); //will hide toolbar if visible
    viewer.toggleSidebar(true);//will show it regardless current state

    Parameters

    • Optional visible: undefined | false | true

      New visibility status. If value is not passed, the function will toggle current state.

    Returns void

toggleToolbar

  • toggleToolbar(show?: undefined | false | true): void
  • Toggle toolbar (hide or show it).

    viewer.toggleToolbar(); // toggles toolbar visibility
    viewer.toggleToolbar(true); //will show it

    Parameters

    • Optional show: undefined | false | true

      Pass true to switch toolbar ON, and vise-versa. Do not pass any value to toggle visibility.

    Returns void