PrizmDoc Viewer v13.16 Release - Updated
API Reference / Viewer Control / Namespace: MarkupLayerSchema
In This Topic
    Namespace: MarkupLayerSchema
    In This Topic

    MarkupLayerSchema

    The following data structures will be used for serializing and deserializing markup layers into a JSON format. This documentation represents the Object Schema for markup layers.

    Properties:

    Name Description
    name : string

    The name of the markup layer.

    originalXmlName : string

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

    data : string

    A property bag of user-defined values.

    marks : Array

    An array of MarkSchema~Mark objects. Note that comments on marks in this layer are stored in this comments array and not stored under the particular mark.

    comments : Array

    An array of MarkupLayerSchema~Comment objects for marks in this layer and in other layers. Note that comments on marks in this layer are stored in this comments array and not stored under the particular mark in the marks array.

    Type Definitions

    Comment

    A mark comment.

    Type:

    • Object

    Properties:

    Name Description
    markUid : string

    The global unique ID for the mark the comment is under.

    data : Object.<key, string>

    A property bag of user-defined values.

    creationDateTime : String

    An ISO string of the created time.

    text : String

    The text of the comment.


    Documentation generated by JSDoc 3.3.3 on Wed Feb 10 2021 11:14:14 GMT-0500 (Eastern Standard Time)