asposediagram.api

asposediagram.api

Class MasterCollection

Master collection.

Example:

var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");

diagram = new aspose.diagram.Diagram("RetrieveMasterInfo.vdx");

masters = diagram.getMasters();
for (var it = masters.iterator(); it.hasNext();) {
    master = it.next();
    // Display information about the masters
    console.log("\nMaster ID : " + master.getID());
    console.log("Master Name : " + master.getName());
}

Property Getters/Setters Summary
methodgetCount()
methodgetMasterShortcuts()
MasterShortcut collection.
methodget(index)
 
Method Summary
methodadd(master)
Add the Master object in the collection.
methodclear()
methodgetMaster(ID)
Gets the element at the specified ID.
methodgetMasterByName(name)
Get master by name.
methodgetMaxRelID()
get the max rel id in the collection.
methodisExist(name)
Is exist master in the collection.
methodisExistRelId(relID)
Is exist master rel id in the collection.
methoditerator()
Reserved for internal use.
methodremove(master)
Remove the Master object from the collection.
methodremoveAt(index)
 

    • Method Detail

      • add

        int add(master)
        Add the Master object in the collection.
        Parameters:
        master: Master -
        Returns:

      • remove

         remove(master)
        Remove the Master object from the collection.
        Parameters:
        master: Master -

      • getMaster

        Master getMaster(ID)
        Gets the element at the specified ID.
        Parameters:
        ID: int -
        Returns:

        Example:

        var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");

diagram = new aspose.diagram.Diagram("RetrieveMasterInfo.vdx");

// Get master object by id
master = diagram.getMasters().getMaster(2);
console.log("Master ID : " + master.getID());
console.log("Master Name : " + master.getName());
console.log("Master Name : " + master.getUniqueID());

      • getMasterByName

        Master getMasterByName(name)
        Get master by name.
        Parameters:
        name: String -
        Returns:

        Example:

        var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");

diagram = new aspose.diagram.Diagram("BasicShapes.vss");

// Get master object by name
master = diagram.getMasters().getMasterByName("Circle");
console.log("Master ID : " + master.getID());
console.log("Master Name : " + master.getName());
console.log("Master Name : " + master.getUniqueID());

      • getMaxRelID

        int getMaxRelID()
        get the max rel id in the collection.
        Parameters:
        name -
        Returns:

      • isExistRelId

        boolean isExistRelId(relID)
        Is exist master rel id in the collection.
        Parameters:
        name -
        Returns:

      • isExist

        boolean isExist(name)
        Is exist master in the collection.
        Parameters:
        name: String -
        Returns:

        Example:

        var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");

diagram = new aspose.diagram.Diagram("BasicShapes.vss");

// check master object by name
isPresent = diagram.getMasters().isExist("60 degree single");

console.log("Master Presence : " + isPresent);

      • clear

         clear()

      • removeAt

         removeAt(index)

      • iterator

        Iterator iterator()
        Reserved for internal use.