PCCViewer. MarkupLayer

A list of events that can be triggered by the PCCViewer.MarkupLayer object.

Note: This enumeration is for convenience for API developers. Instead of using this enumeration, you can pass string values of the eventType (enumeration values)

Gets the layer's ID.

This property is defined on all MarkupLayer objects.

This is an ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

var id = MarkupLayer.id;

Gets and sets the layer's name.

This property is defined on all MarkupLayer objects.

This is an ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

var name = MarkupLayer.name;

Gets and sets the layer's original XML name.

This property is defined on all MarkupLayer objects.

This is an ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

var name = MarkupLayer.originalXmlName;

Gets the ID of web tier record from which this layer was created.

This property is defined on all MarkupLayer objects.

This is an ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

var recordId = MarkupLayer.recordId;

Gets the viewer control associated with this layer.

This property is defined on all MarkupLayer objects.

This is an ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

var viewerControl = MarkupLayer.viewerControl;

Used to add marks to the layer.

Example

var markupLayer = viewerControl.getMarkupLayerCollection().getAll()[0]; // Get the first markup layer.
var mark = viewerControl.addMark(1, 'HighlightAnnotation'); // Create a new mark
markupLayer.addMarks(mark);

Copies marks from other layers to this layer.

Note: This method requires that attributes of each page referenced by the layer marks have been obtained by the viewer prior to calling. Use PCCViewer.ViewerControl#requestPageAttributes to obtain the necessary page attributes before calling this method.

Note: The copied marks are assigned new unique IDs, and any references to the original mark (such as a comment on the mark that is stored in another layer) will not reference the copied mark. A copy of each comment on the mark is put on the copy of the mark in this layer.

Example

var markupLayer1 = viewerControl.getMarkupLayerCollection().getAll()[0]; // Get the first markup layer.
var markupLayer2 = viewerControl.getMarkupLayerCollection().getAll()[1]; // Get the second markup layer.
var markupLayer4 = viewerControl.getMarkupLayerCollection().getAll()[3]; // Get the fourth markup layer.
// Concatenate layers 2 and 4 to a single array.
var layersToCopy = markupLayer2.concat(markupLayer4);
// Copy the layers to this layer.
markupLayer1.copyLayers(layersToCopy);

This method will remove the layer from the viewer control's markup layer collection. Also, it will de-register any event listeners associated with the layer.

Example

var markupLayer = viewerControl.getMarkupLayerCollection().getAll()[0]; // Get the first markup layer.
markupLayer.destroy();

Gets the data value for the given key, or gets a hash containing all key values, if a key was not provided.

This method is defined on all MarkupLayer objects.

Example

// The key "Username" is set the value "Admin".
layer.setData("Username", "Admin");

// The key "CreatedDate" is set the value "1970-01-01".
layer.setData("CreatedDate", "1970-01-01");

layer.getData("Username"); // returns "Admin"
layer.getData();         // returns {"Username":"Admin", "CreatedDate":"1970-01-01"}
layer.getData("FooBar"); // returns undefined

Gets an array of data keys known to this MarkupLayer.

This method is defined on all MarkupLayer objects.

Example

// Returns an empty array before key-value pairs are stored.
layer.getDataKeys(); // returns []

// Returns a list of all keys.
layer.setData("Username", "Admin");
layer.setData("CreatedDate", "1970-01-01");
layer.getDataKeys(); // returns ["Username", "CreatedDate"]

Gets the layer's ID.

Gets the mark references associated with this layer.

Example

var markupLayer = viewerControl.getMarkupLayerCollection().getAll()[0]; // Get the first markup layer.
var markReferences = markupLayer.getMarkReferences();

Gets the marks associated with this layer.

Example

var markupLayer = viewerControl.getMarkupLayerCollection().getAll()[0]; // Get the first markup layer.
var marks = markupLayer.getMarks();

Gets the layer's name.

Example

var markupLayer = viewerControl.getMarkupLayerCollection().getAll()[0]; // Get the first markup layer.
var layerName = markupLayer.getName();

Gets the name of the web tier XML record from which the marks of this layer were originally stored.

Example

var markupLayer = viewerControl.getMarkupLayerCollection().getAll()[0]; // Get the first markup layer.
var originalXmlName = markupLayer.getOriginalXmlName();

Gets the ID of web tier record from which this layer was created.

Example

var markupLayer = viewerControl.getMarkupLayerCollection().getAll()[0]; // Get the first markup layer.
var recordId = markupLayer.getRecordId();

Gets the session data value for the given key, or gets a hash containing all key values, if a key was not provided. Unlike PCCViewer.MarkupLayer#getData, this data is not saved with the annotation, it only lasts for the session.

This method is defined on all MarkupLayer objects.

Example

// The key "Username" is set the value "Admin".
layer.setSessionData("Username", "Admin");

// The key "CreatedDate" is set the value "1970-01-01".
layer.setSessionData("CreatedDate", "1970-01-01");

layer.getSessionData("Username"); // returns "Admin"
layer.getSessionData();           // returns {"Username":"Admin", "CreatedDate":"1970-01-01"}
layer.getSessionData("FooBar");   // returns undefined

Gets an array of data keys known to this MarkupLayer. Unlike PCCViewer.MarkupLayer#getDataKeys, this data is not saved with the annotation, it only lasts for the session.

This method is defined on all MarkupLayer objects.

Example

// Returns an empty array before key-value pairs are stored.
layer.getSessionDataKeys(); // returns []

// Returns a list of all keys.
layer.setSessionData("Username", "Admin");
layer.setSessionData("CreatedDate", "1970-01-01");
layer.getSessionDataKeys(); // returns ["Username", "CreatedDate"]

Gets the viewer control associated with this layer.

Example

var markupLayer = viewerControl.getMarkupLayerCollection().getAll()[0]; // Get the first markup layer.
var viewerControl = markupLayer.getViewerControl();

Used to query the layer to see if it contains a particular mark.

Example

var markupLayer = viewerControl.getMarkupLayerCollection().getAll()[0]; // Get the first markup layer.
var mark = viewerControl.getAllMarks()[0];
var markExistsInLayer = markupLayer.hasMark(mark.getId());

Hides all of the marks in the layer.

Example

var markupLayer = viewerControl.getMarkupLayerCollection().getAll()[0]; // Get the first markup layer.
markupLayer.hide(); // Hide the marks in the layer.

Unsubscribe an event handler from a specified event type.

Typically, an event is unsubscribed when you no longer want further notification of the event.

Subscribe an event handler to an event of a specified type.

Used to remove marks from the layer.

Example

var markupLayer = viewerControl.getActiveMarkupLayer(); // Get the active markup layer.
var mark = viewerControl.addMark(1, 'HighlightAnnotation'); // Create a new mark
markupLayer.removeMarks(mark); // remove the mark from the active layer

Sets the data value for the given key.

This method is defined on all MarkupLayer objects.

Notes:

• Overwrites any data value already associated with the given key.
• There is no artificial limit imposed on the number of key-value pairs that are stored.
• If limits on the number of key-value pairs are required, they should be enforced by calling code.
• Setting the value as undefined results in no information for the key being persisted to the server.
• The returned data is not mutated or sanitized, which could lead to a security vulnerability if not sanitized properly before use.

Example

// Get data returns undefined before the key is set.
layer.getData("Username"); // returns undefined

// The key "Username" is set the value "Admin".
layer.setData("Username", "Admin");
layer.getData("Username"); // returns "Admin"

// The key "Username" is overwritten with the value "Guest1".
layer.setData("Username", "Guest1");
layer.getData("Username"); // returns "Guest1"

// The key "Username" is unset, by setting the value to undefined.
layer.setData("Username", undefined);
layer.getData("Username"); // returns undefined

// The value can only be set to a string or undefined.
// All other data types throw.
layer.setData("FooBar", null); // throws
layer.setData("FooBar", 1);    // throws
layer.setData("FooBar", true); // throws
layer.setData("FooBar", {});   // throws
layer.setData("FooBar", []);   // throws

Used to alter the interaction mode of all marks in a layer.

Example

var markupLayer = viewerControl.getMarkupLayerCollection().getAll()[0]; // Get the first markup layer.
markupLayer.setInteractionMode(PCCViewer.Mark.InteractionMode.SelectionDisabled);

Sets the layer's name.

Example

var markupLayer = viewerControl.getMarkupLayerCollection().getAll()[0]; // Get the first markup layer.
markupLayer.setName('Final Draft');

Sets the name of the web tier XML record from which the marks of this layer were originally stored. If the layer is not associated with an XML file, the property should be set to an empty string.

When the original XML name is set and a markup layer is saved, the original XML name is saved in the markup layer JSON. When the PCCViewer.ViewerControl#requestMarkupLayerNames method is called, the original XML name will be provided.

Example

var markupLayer = viewerControl.getMarkupLayerCollection().getAll()[0]; // Get the first markup layer.
markupLayer.setOriginalXmlName('my marks');
```

Sets the session data value for the given key. Unlike PCCViewer.MarkupLayer#setData, this data is not saved with the annotation, it only lasts for the session.

This method is defined on all MarkupLayer objects.

Example

// Get data returns undefined before the key is set.
layer.getSessionData("Username"); // returns undefined

// The key "Username" is set the value "Admin".
layer.setSessionData("Username", "Admin");
layer.getSessionData("Username"); // returns "Admin"

// The key "Username" is overwritten with the value "Guest1".
layer.setSessionData("Username", "Guest1");
layer.getSessionData("Username"); // returns "Guest1"

// The key "Username" is unset, by setting the value to undefined.
layer.setSessionData("Username", undefined);
layer.getSessionData("Username"); // returns undefined

// The value can only be set to a string or undefined.
// All other data types throw.
layer.setSessionData("FooBar", null); // throws
layer.setSessionData("FooBar", 1);    // throws
layer.setSessionData("FooBar", true); // throws
layer.setSessionData("FooBar", {});   // throws
layer.setSessionData("FooBar", []);   // throws

Shows all of the marks in the layer.

Example

var markupLayer = viewerControl.getMarkupLayerCollection().getAll()[0]; // Get the first markup layer.
markupLayer.show(); // Show the marks in the layer.