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 full)

Constructors

Properties

__jsonld: any
context: string
externalResource: IExternalResource
id: string
isAnnotationBody: boolean = true
isCamera: boolean = false
isLight: boolean = false
isModel: boolean = true
isSpecificResource: boolean = false

Accessors

  • get FieldOfView(): undefined | number
  • Full angular size of perspective viewport in vertical direction. Angular unit is degrees *

    Returns undefined | number

  • get ViewHeight(): undefined | number
  • Returns undefined | number

Methods

  • Returns undefined | number

    full angular size of perspective viewport in vertical direction. Angular unit is degrees *

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

    Returns PropertyValue

    Example

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

    Example

    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

  • Returns undefined | number

    full linear size of orthographic viewport in vertical direction. linear unit is Scene global unit of measure

    Name of this property was originally Height, has been changed at this revision to ViewHeight: See issues at https://github.com/IIIF/api/issues/2289 *