MetaManager
Kind: global interface
- MetaManager
- .setTitle(title)
- .getTitle() ⇒
string
- .setMetaName(name, value)
- .getMetaName(name) ⇒
string
- .getMetaNames() ⇒
Array.<string>
- .setMetaProperty(name, value)
- .getMetaProperty(name) ⇒
string
- .getMetaProperties() ⇒
Array.<string>
- .setLink(relation, reference)
- .getLink(relation) ⇒
string
- .getLinks() ⇒
Array.<string>
metaManager.setTitle(title)
Sets the page title.
Kind: instance method of MetaManager
Param | Type | Description |
---|---|---|
title | string |
The new page title. |
metaManager.getTitle() ⇒ string
Returns the page title. The method returns an empty string if no page title has been set yet.
Note that the page title is cached internally by the meta manager and may therefore differ from the current document title if it has been modified by a 3rd party code.
Kind: instance method of MetaManager
Returns: string
- The current page title.
metaManager.setMetaName(name, value)
Set the specified named meta information property.
Kind: instance method of MetaManager
Param | Type | Description |
---|---|---|
name | string |
Meta information property name, for example keywords . |
value | string |
The meta information value. |
metaManager.getMetaName(name) ⇒ string
Returns the value of the specified named meta information property. The method returns an empty string for missing meta information (to make the returned value React-friendly).
Kind: instance method of MetaManager
Returns: string
- The value of the generic meta information, or an empty
string.
Param | Type | Description |
---|---|---|
name | string |
The name of the named meta information property. |
metaManager.getMetaNames() ⇒ Array.<string>
Returns the names of the currently specified named meta information properties.
Kind: instance method of MetaManager
Returns: Array.<string>
- The names of the currently specified named meta
information properties.
metaManager.setMetaProperty(name, value)
Sets the specified specialized meta information property.
Kind: instance method of MetaManager
Param | Type | Description |
---|---|---|
name | string |
Name of the specialized meta information property. |
value | string |
The value of the meta information property. |
metaManager.getMetaProperty(name) ⇒ string
Returns the value of the specified specialized meta information property. The method returns an empty string for missing meta information (to make the returned value React-friendly).
Kind: instance method of MetaManager
Returns: string
- The value of the specified meta information, or an
empty string.
Param | Type | Description |
---|---|---|
name | string |
The name of the specialized meta information property. |
metaManager.getMetaProperties() ⇒ Array.<string>
Returns the names of the currently specified specialized meta information properties.
Kind: instance method of MetaManager
Returns: Array.<string>
- The names of the currently specified specialized meta
information properties.
metaManager.setLink(relation, reference)
Sets the specified specialized link information.
Kind: instance method of MetaManager
Param | Type | Description |
---|---|---|
relation | string |
The relation of the link target to the current page. |
reference | string |
The reference to the location of the related document, e.g. a URL. |
metaManager.getLink(relation) ⇒ string
Return the reference to the specified related linked document. The method returns an empty string for missing meta information (to make the returned value React-friendly).
Kind: instance method of MetaManager
Returns: string
- The reference to the location of the related document,
e.g. a URL.
Param | Type | Description |
---|---|---|
relation | string |
The relation of the link target to the current page. |
metaManager.getLinks() ⇒ Array.<string>
Returns the relations of the currently set related documents linked to the current page.
Kind: instance method of MetaManager