Constructor
new $k.Tag(canonicalText)
Creates a new tag
| Name | Type | Description |
|---|---|---|
canonicalText | string | The canonical text |
Methods
canonicalText() → {string}
Returns the canonical text of the tag
- Since
- 5.2.0
- Type:
- string
customProperties() → {object}
Returns optional custom properties of the tag
- Since
- 5.2.0
- Type:
- object
element() → {$k.SemanticElement}
The semantic element associated with this tag
- Since
- 5.2.0
- Type:
- $k.
SemanticElement
interfaceTagType() → {string}
Returns the tag type returned by the tagging interface
- Since
- 5.2.0
- Type:
- string
language() → {string}
Returns the language of the tag
- Since
- 5.2.0
- Type:
- string
linkingRelation() → {$k.Relation}
Returns the relation between the source object and the tagged object
- Since
- 5.2.0
- Type:
- $k.
Relation
quality() → {number}
Returns the quality of the tag as returned by the interface
- Since
- 5.2.0
- Type:
- number
setCanonicalText()
Sets the canonical text of the tag
- Since
- 5.2.0
setElement(element)
Set the semantic element associated with this tag
| Name | Type | Description |
|---|---|---|
element | $k. |
- Since
- 5.2.0
setInterfaceTagType(tagType)
Set the interface tag type. This type can be used in the tagging configuration.
| Name | Type | Description |
|---|---|---|
tagType | string |
- Since
- 5.2.0
setLanguage(language)
Sets the language of the tag
| Name | Type | Description |
|---|---|---|
language | string |
- Since
- 5.2.0
setLinkingRelation(linkingRelation)
Sets the relation between the source object and the tagged object
| Name | Type | Description |
|---|---|---|
linkingRelation | $k. |
- Since
- 5.2.0
setQuality(quality)
Sets the quality of the tag
| Name | Type | Description |
|---|---|---|
quality | number |
- Since
- 5.2.0
setTextVariants(variants)
Sets other text variants of the tag
| Name | Type | Description |
|---|---|---|
variants | Array.<string> |
- Since
- 5.2.0
spans() → {Array.<object>}
Returns the spans of the tag. A span is returned as { start: startIndex, end: endIndex }
- Since
- 5.2.0
- Type:
- Array.<object>
tagTypePriority() → {number}
Returns the priority of the tag type, given by the order in the hierarchy
- Since
- 5.3.0
- Type:
- number
textVariants() → {Array.<string>}
Returns other text variants of the tag found in the text
- Since
- 5.2.0
- Type:
- Array.<string>