---
product: Chilkat
product_version: 11.7.0
language: js
language_label: JavaScript
class: Xmp
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/jsXmpRef.html
---
# Chilkat Xmp — JavaScript — v11.7.0

> Chilkat 11.7.0 · language=js · class=Xmp
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Xmp.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/guide.md`.

## Purpose

**Read, modify, add, remove, and save XMP metadata in JPG and TIFF files.**

`Chilkat.Xmp` is a legacy class for working with embedded XMP metadata in `JPG` and `TIFF` image files. It can load image files or image data from memory, locate embedded XMP documents, return XMP metadata as `Chilkat.Xml`, create new XMP documents, add or update simple string and integer properties, manage arrays and structured properties, add namespace mappings, remove selected XMP properties or entire embedded XMP documents, and save the updated image back to a file or byte buffer.

**Legacy class:** `Chilkat.Xmp` is maintained for existing JPG/TIFF XMP workflows, but it is not planned to be extended to support additional file types.

**Load JPG or TIFF metadata**

Load a `JPG` or `TIFF` file from disk or memory and inspect how many embedded XMP documents were found.

**Access XMP as XML**

Retrieve embedded XMP documents as `Chilkat.Xml` objects for inspection, editing, or direct XML-level processing.

**Add simple properties**

Add or update namespace-qualified string and integer properties such as `dc:subject`, `photoshop:Credit`, or `tiff:XResolution`.

**Arrays and structures**

Work with XMP arrays such as `bag`, `seq`, and `alt`, and manage structured property values.

**Namespaces**

Use built-in namespace mappings or add custom namespace-to-URI mappings for application-specific XMP properties.

**Remove and save**

Remove properties, arrays, structures, or embedded XMP documents, then persist changes to a file or return the updated image as a byte buffer.

**Common pattern:** Load a JPG or TIFF with `LoadAppFile` or `LoadFromBuffer`, retrieve an embedded XMP document with `GetEmbedded` or create one with `NewXmp`, modify it using the add/remove property methods, then call `SaveAppFile` or `SaveToBuffer` to persist the updated image metadata.

**Persistence note:** Changes made to the XMP XML object are not written back to the image file until `SaveAppFile` is called. For memory workflows, use `SaveToBuffer` to obtain the updated JPG or TIFF bytes.

## Object creation, unlocking and error handling

**Object Creation**

Note: This is intended for running within a [Chilkat.Js embedded JavaScript engine](https://www.chilkatsoft.com/chilkat_javascript_engine.asp).

```
var obj = new CkXmp();
```

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in JavaScript.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `DebugLogFilePath` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `LastErrorHtml` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `VerboseLogging` | `VerboseLogging` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `NumEmbedded` | property, read-only | `NumEmbedded` |
| `StructInnerDescrip` | property, read/write | `StructInnerDescrip` |
| `UncommonOptions` | property, read/write | `UncommonOptions` |
| `AddArray` | method | `var success = AddArray(xml, arrType, propName, values);` |
| `AddNsMapping` | method | `AddNsMapping(ns, uri);` |
| `AddSimpleInt` | method | `var success = AddSimpleInt(iXml, propName, propVal);` |
| `AddSimpleStr` | method | `var success = AddSimpleStr(iXml, propName, propVal);` |
| `AddStructProp` | method | `var success = AddStructProp(iChilkatXml, structName, propName, propValue);` |
| `Append` | method | `var success = Append(iXml);` |
| `GetSimpleInt` | method | `var intVal = GetSimpleInt(iXml, propName);` |
| `GetSimpleStr` | method | `var strVal = GetSimpleStr(iXml, propName);` |
| `GetStructValue` | method | `var strVal = GetStructValue(iXml, structName, propName);` |
| `LoadAppFile` | method | `var success = LoadAppFile(filename);` |
| `RemoveAllEmbedded` | method | `var success = RemoveAllEmbedded();` |
| `RemoveArray` | method | `var success = RemoveArray(iXml, propName);` |
| `RemoveEmbedded` | method | `var success = RemoveEmbedded(index);` |
| `RemoveNsMapping` | method | `RemoveNsMapping(ns);` |
| `RemoveSimple` | method | `var success = RemoveSimple(iXml, propName);` |
| `RemoveStruct` | method | `var success = RemoveStruct(iXml, structName);` |
| `RemoveStructProp` | method | `var success = RemoveStructProp(iXml, structName, propName);` |
| `SaveAppFile` | method | `var success = SaveAppFile(filename);` |

## Properties

### Xmp.NumEmbedded

`Chilkat 11.7.0 · js · Xmp · NumEmbedded · property · read-only`

```javascript
NumEmbedded
```

· `int`, `read-only`

The number of XMP metadata documents found within the JPG or TIFF file loaded by LoadAppFile.

### Xmp.StructInnerDescrip

`Chilkat 11.7.0 · js · Xmp · StructInnerDescrip · property · read/write`

```javascript
StructInnerDescrip
```

· `boolean`

Determines whether structures are stored with rdf:parseType=`Resource`, or within an `rdf:Description` sub-node.

### Xmp.UncommonOptions

`Chilkat 11.7.0 · js · Xmp · UncommonOptions · property · read/write · since 9.5.0.80`

```javascript
UncommonOptions
```

· `string`

A property to be used for future uncommon needs. The default value is the empty string.

## Methods

### Xmp.AddArray

`Chilkat 11.7.0 · js · Xmp · AddArray · method`

```javascript
var success = AddArray(xml, arrType, propName, values);
```

· return: `boolean`; `true` for success, `false` for failure  
· xml: `CkXml`  
· arrType: `string`  
· propName: `string`  
· values: `CkStringArray`

Adds or replaces an XMP property array. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The 2nd argument specifies the array type, which can be `bag`, `seq`, or `alt`. The property name should be prefixed with the namespace, such as `dc:subject`.

Returns true for success, false for failure.

### Xmp.AddNsMapping

`Chilkat 11.7.0 · js · Xmp · AddNsMapping · method`

```javascript
AddNsMapping(ns, uri);
```

· return: `undefined`  
· ns: `string`  
· uri: `string`

Adds a namespace to URI mapping. When a property is added via AddSimpleString or any of the other methods, the property name is namespace qualified. When adding the first property in a namespace, the rdf:Description is automatically added and the URI is obtained from the namespace-to-URI mappings. The standard (and commonly used) namespace mappings are defined by default. This is only used if the namespace is custom or not already handled.

### Xmp.AddSimpleInt

`Chilkat 11.7.0 · js · Xmp · AddSimpleInt · method`

```javascript
var success = AddSimpleInt(iXml, propName, propVal);
```

· return: `boolean`; `true` for success, `false` for failure  
· iXml: `CkXml`  
· propName: `string`  
· propVal: `int`

Adds or updates an XMP integer property. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The property name should be prefixed with the namespace, such as `tiff:XResolution`.

Returns true for success, false for failure.

### Xmp.AddSimpleStr

`Chilkat 11.7.0 · js · Xmp · AddSimpleStr · method`

```javascript
var success = AddSimpleStr(iXml, propName, propVal);
```

· return: `boolean`; `true` for success, `false` for failure  
· iXml: `CkXml`  
· propName: `string`  
· propVal: `string`

Adds or updates a simple XMP string property. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The property name should be prefixed with the namespace, such as `photoshop:Credit`.

Returns true for success, false for failure.

### Xmp.AddStructProp

`Chilkat 11.7.0 · js · Xmp · AddStructProp · method`

```javascript
var success = AddStructProp(iChilkatXml, structName, propName, propValue);
```

· return: `boolean`; `true` for success, `false` for failure  
· iChilkatXml: `CkXml`  
· structName: `string`  
· propName: `string`  
· propValue: `string`

Adds or updates an XMP structured property value. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The structure name should be prefixed with the namespace, such as `Iptc4xmpCore:CreatorContactInfo`. The property name within the structure should also be prefixed with the namespace, such as `Iptc4xmpCore:CiAdrCity`.

Returns true for success, false for failure.

### Xmp.Append

`Chilkat 11.7.0 · js · Xmp · Append · method`

```javascript
var success = Append(iXml);
```

· return: `boolean`; `true` for success, `false` for failure  
· iXml: `CkXml`

Appends a new XMP metadata file to the XMP object. Any XMPs appended via this method will be present in the file when SaveAppFile is called. Files containing XMP metadata typically only include a single XMP document, so this method is usually only called when adding XMP metadata to a file for the first time.

Returns true for success, false for failure.

### Xmp.GetSimpleInt

`Chilkat 11.7.0 · js · Xmp · GetSimpleInt · method`

```javascript
var intVal = GetSimpleInt(iXml, propName);
```

· return: `int`  
· iXml: `CkXml`  
· propName: `string`

Finds and returns an XMP integer property. The property name should be prefixed with the namespace, such as `tiff:ResolutionUnit`.

### Xmp.GetSimpleStr

`Chilkat 11.7.0 · js · Xmp · GetSimpleStr · method`

```javascript
var strVal = GetSimpleStr(iXml, propName);
```

· return: `string`  
· iXml: `CkXml`  
· propName: `string`

Finds and returns an XMP simple string property. The property name should be prefixed with the namespace, such as `photoshop:Source`.

Returns `null` on failure

### Xmp.GetStructValue

`Chilkat 11.7.0 · js · Xmp · GetStructValue · method`

```javascript
var strVal = GetStructValue(iXml, structName, propName);
```

· return: `string`  
· iXml: `CkXml`  
· structName: `string`  
· propName: `string`

Returns the value of a single item within an XMP structure property. Property names should always be prefixed with the namespace.

Returns `null` on failure

### Xmp.LoadAppFile

`Chilkat 11.7.0 · js · Xmp · LoadAppFile · method`

```javascript
var success = LoadAppFile(filename);
```

· return: `boolean`; `true` for success, `false` for failure  
· filename: `string`

Loads a TIFF or JPG file into the XMP object.

Returns true for success, false for failure.

### Xmp.RemoveAllEmbedded

`Chilkat 11.7.0 · js · Xmp · RemoveAllEmbedded · method`

```javascript
var success = RemoveAllEmbedded();
```

· return: `boolean`; `true` for success, `false` for failure

Removes all XMP metadata documents from an XMP object. After calling this method, call SaveAppFile to rewrite the JPG or TIFF file with the XMP metadata removed.

Returns true for success, false for failure.

### Xmp.RemoveArray

`Chilkat 11.7.0 · js · Xmp · RemoveArray · method`

```javascript
var success = RemoveArray(iXml, propName);
```

· return: `boolean`; `true` for success, `false` for failure  
· iXml: `CkXml`  
· propName: `string`

Removes an XMP array property from the XMP document.

Returns true for success, false for failure.

### Xmp.RemoveEmbedded

`Chilkat 11.7.0 · js · Xmp · RemoveEmbedded · method`

```javascript
var success = RemoveEmbedded(index);
```

· return: `boolean`; `true` for success, `false` for failure  
· index: `int`

Removes a single XMP metadata document from the JPG or TIFF file. Call SaveAppFile to persist the changes to disk.

Returns true for success, false for failure.

### Xmp.RemoveNsMapping

`Chilkat 11.7.0 · js · Xmp · RemoveNsMapping · method`

```javascript
RemoveNsMapping(ns);
```

· return: `undefined`  
· ns: `string`

Removes a namespace-to-URI mapping.

### Xmp.RemoveSimple

`Chilkat 11.7.0 · js · Xmp · RemoveSimple · method`

```javascript
var success = RemoveSimple(iXml, propName);
```

· return: `boolean`; `true` for success, `false` for failure  
· iXml: `CkXml`  
· propName: `string`

Removes a simple XMP property from the XMP document.

Returns true for success, false for failure.

### Xmp.RemoveStruct

`Chilkat 11.7.0 · js · Xmp · RemoveStruct · method`

```javascript
var success = RemoveStruct(iXml, structName);
```

· return: `boolean`; `true` for success, `false` for failure  
· iXml: `CkXml`  
· structName: `string`

Removes an XMP structure property from the XMP document.

Returns true for success, false for failure.

### Xmp.RemoveStructProp

`Chilkat 11.7.0 · js · Xmp · RemoveStructProp · method`

```javascript
var success = RemoveStructProp(iXml, structName, propName);
```

· return: `boolean`; `true` for success, `false` for failure  
· iXml: `CkXml`  
· structName: `string`  
· propName: `string`

Removes a single member from an XMP structured property.

Returns true for success, false for failure.

### Xmp.SaveAppFile

`Chilkat 11.7.0 · js · Xmp · SaveAppFile · method`

```javascript
var success = SaveAppFile(filename);
```

· return: `boolean`; `true` for success, `false` for failure  
· filename: `string`

Persists all changes made to the XMP document(s) by saving the XMP object to a file. Changes made by adding, updating, or removing properties are not persisted to the filesystem until this is called.

Returns true for success, false for failure.

## Related classes

[`StringArray`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/classes/StringArray.md), [`Xml`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/classes/Xml.md)