manifesto
    Preparing search index...

    Class Light

    With the 3D extensions to the IIIF Presentation API the name of this class is misleading, but for now is being retained for the sake backward compatibility with earlier manifesto code and tests.

    The 3D extensions allow that the body property of an annotation can be a light, camera, or model, or a SpecificResource object wrapping a light, camera, or model. *

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    __jsonld context externalResource id options

    Accessors

    Angle Color Intensity LookAt

    Methods

    getAngle getColor getDefaultLabel getFormat getHeight getIIIFResourceType getIntensity getLabel getLookAt getMetadata getProperty getPropertyAsObject getPropertyFromSelfOrSource getRendering getRenderings getRequiredStatement getResourceID getService getServices getSource getSummary getThumbnail getTransform getTransformMatrix getTransformSet getType getWidth isAmbientLight isAnnotation isCanvas isCollection isDirectionalLight isManifest isModel isPointLight isRange isScene isSequence isSpecificResource isSpotLight

    Constructors

    Properties

    __jsonld

    __jsonld: any
    context: string
    externalResource: IExternalResource
    id: string
    options: IManifestoOptions

    Accessors

    • get Angle(): undefined | number

      Returns undefined | number

    Methods

    • The implementation of the intensity is based on temp-draft-4.md and the example 3D manifests lights on 24 Mar 2024. The intensity property in the manifest is an object with declared type 'Value', a numeric property named 'value' and a property named unit . This implementation will only work with a unit == 'relative' and it will be assumed that a relative unit value of 1.0 corresponds to the brightest light source a rendering engine supports.

      This code will implement a default intensity of 1.0

      Returns number

    • 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",

    • Returns null | object | PointSelector

      : if not null, is either a PointSelector, or an object with an id matching the id of an Annotation instance.

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods