@frameright/image-display-control-metadata-parser • Docs

---

@frameright/image-display-control-metadata-parser / Parser

Class: Parser

Parses the XMP metadata of an image, relevant for Image Display Control, i.e. mostly the image regions, see https://iptc.org/std/photometadata/specification/IPTC-PhotoMetadata#image-region

Contents

• Constructors
  • new Parser()
• Methods
  • getIdcMetadata()
  • getXmpMetadata()
  • getSize()

Constructors

new Parser()

new Parser(buffer): Parser

Parameters

• buffer: Buffer | ArrayBuffer

The image file content.

Returns

Parser

Source

index.ts:30

Methods

getIdcMetadata()

getIdcMetadata(shapeFilter, roleFilter, essentialOnly): ImageRegion[]

Returns XMP IDC metadata in a format similar to what this web-component expects: https://github.com/Frameright/image-display-control-web-component

Parameters

• shapeFilter: ShapeFilter= 'any'

Can be used to retrieve only regions of a specific shape, e.g. 'rectangle'.

• roleFilter: RoleFilter= 'any'

Can be used to retrieve only regions of a specific kind of role, e.g. 'crop'.

• essentialOnly: boolean= true

If true, only essential region properties will be returned, e.g. properties like types and roles will be skipped.

Returns

ImageRegion[]

Source

index.ts:52

---

getXmpMetadata()

getXmpMetadata(): XmpTags

Dumps all XMP metadata.

Returns

XmpTags

An instance of ExifReader.XmpTags

Source

index.ts:108

---

getSize()

getSize(): Size

Returns the size of the image in pixels.

Returns

Size

Note

Caches the result in this._size for future calls.

Source

index.ts:117