Defines an XMP packet associated with a Document or Property. See XMP.

Hierarchy

  • ExtensionProperty<IPacket>
    • Packet

Properties

parentTypes: PropertyType[]
propertyType: "Packet"

Methods

  • Makes a copy of this property, with the same resources (by reference) as the original.

  • copy(other: Packet, resolve?: PropertyResolver<Property<IProperty>>): Packet
  • Copies all data from another property to this one. Child properties are copied by reference, unless a 'resolve' function is given to override that.

  • dispatchEvent(event: BaseEvent): Packet
  • Events.

  • dispose(): void
  • Removes both inbound references to and outbound references from this object. At the end of the process the object holds no references, and nothing holds references to it. A disposed object is not reusable.

  • equals(other: Packet, skip?: Set<string>): boolean
  • Returns true if two properties are deeply equivalent, recursively comparing the attributes of the properties. Optionally, a 'skip' set may be included, specifying attributes whose values should not be considered in the comparison.

    Example: Two Primitives are equivalent if they have accessors and materials with equivalent content — but not necessarily the same specific accessors and materials.

  • fromJSONLD(jsonld: Record<string, unknown>): Packet
  • getContext(): Record<string, TermDefinition>
  • getDefaults(): Nullable<IPacket>
  • getExtras(): Record<string, unknown>
  • Returns a reference to the Extras object, containing application-specific data for this Property. Extras should be an Object, not a primitive value, for best portability.

  • getName(): string
  • Returns the name of this property. While names are not required to be unique, this is encouraged, and non-unique names will be overwritten in some tools. For custom data about a property, prefer to use Extras.

  • getProperty(name: string): Record<string, unknown> | Value
  • Returns the value of a property, as a literal or JSONLD object.

    Example:

    packet.getProperty('dc:Creator'); // → {"@list": ["Acme, Inc."]}
    packet.getProperty('dc:Title'); // → {"@type": "rdf:Alt", "rdf:_1": {"@language": "en-US", "@value": "Lamp"}}
    packet.getProperty('xmp:CreateDate'); // → "2022-01-01"
    
  • init(): void
  • isDisposed(): boolean
  • Returns true if the node has been permanently removed from the graph.

  • listParents(): Property<IProperty>[]
  • Returns a list of all properties that hold a reference to this property. For example, a material may hold references to various textures, but a texture does not hold references to the materials that use it.

    It is often necessary to filter the results for a particular type: some resources, like Accessors, may be referenced by different types of properties. Most properties include the Root as a parent, which is usually not of interest.

    Usage:

    const materials = texture
        .listParents()
        .filter((p) => p instanceof Material)
    
  • listProperties(): string[]
  • setContext(context: Record<string, TermDefinition>): Packet
  • setExtras(extras: Record<string, unknown>): Packet
  • Updates the Extras object, containing application-specific data for this Property. Extras should be an Object, not a primitive value, for best portability.

  • setName(name: string): Packet
  • Sets the name of this property. While names are not required to be unique, this is encouraged, and non-unique names will be overwritten in some tools. For custom data about a property, prefer to use Extras.

  • setProperty(name: string, value: Record<string, unknown> | Value): Packet
  • Sets the value of a property, as a literal or JSONLD object.

    Example:

    packet.setProperty('dc:Creator', {'@list': ['Acme, Inc.']});
    packet.setProperty('dc:Title', {
        '@type': 'rdf:Alt',
        'rdf:_1': {'@language': 'en-US', '@value': 'Lamp'}
    });
    packet.setProperty('model3d:preferredSurfaces', {'@list': ['vertical']});
    
  • toJSONLD(): Record<string, unknown>
Function symbol, f(📦) → 📦, where the argument and output are a box labeled 'glTF'.

Made by Don McCurdy TypeDoc documentation Copyright 2021 under MIT license