Interface IMetadata

Package: @aurigma/design-atoms-text

Methods

deleteProperty(name)

Removes the value of the metadata property by name.

Declaration

deleteProperty(name: string): boolean;

Parameters

Type	Name	Description
string	name	property name.

Returns

Type	Description
boolean

getProperties()

Returns all metadata properties.

Declaration

getProperties(): IMetadataProperty[];

Returns

Type	Description
IMetadataProperty[]

getPropertiesCount()

Returns the number of metadata properties.

Declaration

getPropertiesCount(): number;

Returns

Type	Description
number

getProperty(name)

Returns metadata property by name.

Declaration

getProperty(name: string): IMetadataProperty;

Parameters

Type	Name	Description
string	name	property name.

Returns

Type	Description
IMetadataProperty

isPropertyExists(name)

Checks for metadata property existence.

Declaration

isPropertyExists(name: string): boolean;

Parameters

Type	Name	Description
string	name	property name. true if the template image exists, false otherwise.

Returns

Type	Description
boolean

setProperty(name, value)

Sets the value of a metadata property by name.

Declaration

setProperty(name: string, value: string): void;

Parameters

Type	Name	Description
string	name	property name.
string	value	property value.

Returns

Type	Description
void

Remarks

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