Class TextWhizzMetadata

Package: @aurigma/design-atoms-text

Constructors

(constructor)(tw, properties)

Constructs a new instance of the TextWhizzMetadata class

Declaration

constructor(tw: typeof TextWhizz, properties?: IMetadataProperty[]);

Parameters

Type	Name	Description
typeof TextWhizz	tw
IMetadataProperty[]	properties

Methods

deleteProperty(name)

Declaration

deleteProperty(name: string): boolean;

Parameters

Type	Name	Description
string	name

Returns

Type	Description
boolean

getEntry()

Returns the metadata in a TextWhizz format.

Declaration

getEntry(): TextWhizz.StringMap;

Returns

Type	Description
TextWhizz.StringMap

getProperties()

Declaration

getProperties(): IMetadataProperty[];

Returns

Type	Description
IMetadataProperty[]

getPropertiesCount()

Declaration

getPropertiesCount(): number;

Returns

Type	Description
number

getProperty(name)

Declaration

getProperty(name: string): IMetadataProperty;

Parameters

Type	Name	Description
string	name

Returns

Type	Description
IMetadataProperty

isPropertyExists(name)

Declaration

isPropertyExists(name: string): boolean;

Parameters

Type	Name	Description
string	name

Returns

Type	Description
boolean

setEntry(metadata)

Sets metadata by TextWhizz entry (patch).

Declaration

setEntry(metadata: TextWhizz.StringMap): void;

Parameters

Type	Name	Description
TextWhizz.StringMap	metadata	metadata in a TextWhizz format.

Returns

Type	Description
void

setProperty(name, value)

Declaration

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

Parameters

Type	Name	Description
string	name
string	value

Returns

Type	Description
void