manifesto
    Preparing search index...

    Class Manifest

    Scenes are conveniently retrieved from a Manifest by iterating through Sequence in the Manifest, inner loop the Scenes in each sequence

    Sequence

    var manifest: Manifest;
    function doSomethingWithScene(scene:Scene)...
    ...
    foreach(var seq:Sequence of manifest.getSequences()
      foreach(var scene : Scene of seq.getScenes()
        doSomethingWithScene(scene);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    __jsonld _annotationIdMap context defaultTree externalResource id index isLoaded items options parentCollection parentLabel

    Accessors

    annotationIdMap

    Methods

    getAccompanyingCanvas getAllRanges getAttribution getBehavior getDefaultLabel getDefaultTree getDescription getHomepage getIIIFResourceType getLabel getLicense getLogo getManifestType getMetadata getNavDate getPosterCanvas getProperty getPropertyAsObject getRangeById getRangeByPath getRelated getRendering getRenderings getRequiredStatement getRights getSeeAlso getSequenceByIndex getSequences getService getServices getSummary getThumbnail getTopRanges getTotalSequences getTrackingLabel getViewingDirection getViewingHint isAnnotation isCanvas isCollection isManifest isMultiSequence isPagingEnabled isRange isScene isSequence load

    Constructors

    Properties

    __jsonld

    __jsonld: any

    _annotationIdMap

    _annotationIdMap: any
    context: string
    defaultTree: TreeNode
    externalResource: IExternalResource
    id: string
    index: number = 0
    isLoaded: boolean = false
    items: Sequence[] = []
    options: IManifestoOptions
    parentCollection: Collection
    parentLabel: string

    Accessors

    • get annotationIdMap(): Object

      Developer Note: The concept of the "id map" appear in the JSON-LD specification https://www.w3.org/TR/json-ld11/#dfn-id-map This functionality may be available as well in the 'nodeMap' code of the digitalbazaar/jsonld library

      this very simplified version just returns a mao of id -> Annotation nodes in manifest

      THe annotationIdMap is a Javascript object whose property names are IRI (id values) and property values are instances of the Annotation class

      Returns Object

    Methods

    • returns the PropertyValue which in turn allows a language-specific string encoded in the json as the "label" property

      Returns PropertyValue

      var label = manifest.getLabel().getValue(); // returns the string for default locale

      var label = manifest.getLabel().getValue(locale); // locale a string , examples
                                                        // would be "fr", "en-US",

    • A function that wraps the getProperty function, which client code can use if it is needed to identify when the json value of a property is an IRI -- Internationalized Resource Identifier

      If the value of the json value is a bare string, then it will be wrapped in a json object with the string in the property 'id', additionally that property will have a property 'isIRI' which will be true for the literal string case, otherwise false meaning the returned getProperty should be parsed as before.

      Parameters

      • name: string

      Returns any

    • Returns null | ViewingDirection

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods