getIds Method


Retrieves an array containing all the document IDs that are currently loaded into the Viewer.

Viewer.prototype.getIds = function() 
getIds(): string[]; 

Return Value

An array of strings corresponding to all the IDs that were found. If the run method has not been called, or if a file is not loaded into the Viewer, then an empty array is returned.

export class ViewerGetIdsExample { 
    private _viewer: lt.LEADVIEW.Viewer = null; 
    private _demoUrl = ''; 
    public constructor() { 
            lt.RasterSupport.setLicenseUri("", "EVAL", null); 
    public run = (divID: string, setButtonID: string, getButtonID: string): void => { 
        const lv = new lt.LEADVIEW.Viewer(); 
        // Builds a new instance of LEADVIEW. 
        // For the full list of options that can be passed to the run method, 
        // refer to the settings JSON files that are included in the LEADVIEW demo application. 
        // Settings files can also be generated from the LEADVIEW application itself., { 
            'rootDivId': divID, 
            'showMainMenu': false, 
            'serviceHost': 'http://localhost:40000', // or wherever your host is 
            'servicePath': '', // the path to the root of the service, which is nothing for this example 
            'serviceApiPath': 'api', // Routing occurs at "/api", unless you change the routing in the DocumentsService 
        this._viewer = lv; 
        document.getElementById(setButtonID).onclick = this.setCurrentDocument; 
        document.getElementById(getButtonID).onclick = this.getIds; 
    private setCurrentDocument = () => { 
        lt.Document.DocumentFactory.loadFromUri(this._demoUrl, null).done((document) => { 
        }).fail((jqXHR, statusText, errorThrown) => { 
            const serviceError = lt.Document.ServiceError.parseError(jqXHR, statusText, errorThrown); 
            alert(`There was an error loading in the document. ${serviceError.message}`); 
    private getIds = () => { 
        const ids = this._viewer.getIds(); 
        alert(`Current ID's: ${ids}`); 
<!doctype html> 
<html lang="en"> 
<title>LV Examples | GetIds</title> 
    <script src="" 
        integrity="sha256-BbhdlvQf/xTY9gja0Dq3HiwQF8LaCRTXxZKRutelT44=" crossorigin="anonymous"></script> 
    <script src="../LT/Leadtools.js"></script> 
    <script src="../LT/Leadtools.Controls.js"></script> 
    <script src="../LT/Leadtools.Annotations.Engine.js"></script> 
    <script src="../LT/Leadtools.Annotations.Designers.js"></script> 
    <script src="../LT/Leadtools.Annotations.Rendering.Javascript.js"></script> 
    <script src="../LT/Leadtools.Annotations.Automation.js"></script> 
    <script src="../LT/Leadtools.ImageProcessing.Main.js"></script> 
    <script src="../LT/Leadtools.ImageProcessing.Color.js"></script> 
    <script src="../LT/Leadtools.ImageProcessing.Core.js"></script> 
    <script src="../LT/Leadtools.ImageProcessing.Effects.js"></script> 
    <script src="../LT/Leadtools.Document.js"></script> 
    <script src="../LT/Leadtools.Document.Viewer.js"></script> 
    <script src="../LT/Leadtools.LEADVIEW.js" defer></script> 
    <link href="../css/Leadtools.LEADVIEW.css" type="text/css" rel="stylesheet"> 
    <!-- All typescript files compiled from /src/ will be bundled and dropped into the root folder `bundle.js`--> 
    <script src="../bundle.js" type="text/javascript"></script> 
        <button id="setCurrentDocument">Set Current Document</button> 
        <button id="getIds">Get Current IDS</button> 
    <div id="runDemo" style="width: 100%; height: 97vh;"></div> 
    window.onload = () => { 
        const example = new window.examples.ViewerGetIdsExample();'runDemo', 'setCurrentDocument', 'getIds'); 

Target Platforms

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.LEADVIEW Assembly

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.