Skip to content

TextElement

Represents a piece of pure markdown text.

Extends

  • AbstractMarkdownLiteral

Constructors

new TextElement()

new TextElement(apiInstance, content, bold, cursive, underline, highlight): TextElement

Parameters

Parameter Type

apiInstance

API

content

string

bold

boolean

cursive

boolean

underline

boolean

highlight

boolean

Returns

TextElement

Overrides

AbstractMarkdownLiteral.constructor

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:176

Properties

apiInstance

readonly apiInstance: API

Inherited from

AbstractMarkdownLiteral.apiInstance

Defined in

jsEngine/api/markdown/AbstractMarkdownElement.ts:9


bold

bold: boolean

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:171


content

content: string

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:170


cursive

cursive: boolean

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:172


highlight

highlight: boolean

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:174


underline

underline: boolean

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:173

Methods

toMarkdown()

toMarkdown(): MarkdownString

Converts the element to a MarkdownString.

Returns

MarkdownString

Inherited from

AbstractMarkdownLiteral.toMarkdown

Defined in

jsEngine/api/markdown/AbstractMarkdownElement.ts:28


toString()

toString(): string

Converts the element to a string.

Returns

string

Overrides

AbstractMarkdownLiteral.toString

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:186