TextWhizzMetadata

Classes

TextWhizzMetadata

Implements

• IMetadata

Constructors

Constructor

new TextWhizzMetadata(tw, properties?): TextWhizzMetadata;

Parameters

Parameter	Type
tw	any
properties?	IMetadataProperty[]

Returns

TextWhizzMetadata

Methods

deleteProperty()

deleteProperty(name): boolean;

Removes the value of the metadata property by name.

Parameters

Parameter	Type	Description
name	string	property name.

Returns

boolean

Implementation of

IMetadata.deleteProperty

getEntry()

getEntry(): StringMap;

Returns the metadata in a TextWhizz format.

Returns

StringMap

getProperties()

getProperties(): IMetadataProperty[];

Returns all metadata properties.

Returns

IMetadataProperty[]

Implementation of

IMetadata.getProperties

getPropertiesCount()

getPropertiesCount(): number;

Returns the number of metadata properties.

Returns

number

Implementation of

IMetadata.getPropertiesCount

getProperty()

getProperty(name): IMetadataProperty;

Returns metadata property by name.

Parameters

Parameter	Type	Description
name	string	property name.

Returns

IMetadataProperty

Implementation of

IMetadata.getProperty

isPropertyExists()

isPropertyExists(name): boolean;

Checks for metadata property existence.

Parameters

Parameter	Type	Description
name	string	property name.

Returns

boolean

true if the template image exists, false otherwise.

Implementation of

IMetadata.isPropertyExists

setEntry()

setEntry(metadata): void;

Sets metadata by TextWhizz entry (patch).

Parameters

Parameter	Type	Description
metadata	StringMap	metadata in a TextWhizz format.

Returns

void

setProperty()

setProperty(name, value): void;

Sets the value of a metadata property by name.

Parameters

Parameter	Type	Description
name	string	property name.
value	string	property value.

Returns

void

Remarks

if a property with the same name already exists, its value is overwritten.

Implementation of

IMetadata.setProperty