CodeBlockElement

Represents a markdown code block.

Extends

• AbstractMarkdownElementContainer

Constructors

new CodeBlockElement()

new CodeBlockElement(apiInstance, language, content): CodeBlockElement

Parameters

Parameter	Type
apiInstance	API
language	string
content	string

Returns

CodeBlockElement

Overrides

AbstractMarkdownElementContainer.constructor

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:361

Properties

apiInstance

readonly apiInstance: API

Inherited from

AbstractMarkdownElementContainer.apiInstance

Defined in

jsEngine/api/markdown/AbstractMarkdownElement.ts:9

---

language

language: string

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:359

---

markdownElements

markdownElements: AbstractMarkdownElement[]

Inherited from

AbstractMarkdownElementContainer.markdownElements

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:12

Methods

addBoldText()

addBoldText(text): AbstractMarkdownElementContainer

Parameters

Parameter	Type
text	string

Returns

AbstractMarkdownElementContainer

Inherited from

AbstractMarkdownElementContainer.addBoldText

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:53

---

addCode()

addCode(text): AbstractMarkdownElementContainer

Parameters

Parameter	Type
text	string

Returns

AbstractMarkdownElementContainer

Inherited from

AbstractMarkdownElementContainer.addCode

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:85

---

addCursiveText()

addCursiveText(text): AbstractMarkdownElementContainer

Parameters

Parameter	Type
text	string

Returns

AbstractMarkdownElementContainer

Inherited from

AbstractMarkdownElementContainer.addCursiveText

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:61

---

addElement()

addElement(element): void

Adds a child element to the container.

Parameters

Parameter	Type	Description
element	AbstractMarkdownElement

Returns

void

Throws

Error if the element is not allowed in the container.

Inherited from

AbstractMarkdownElementContainer.addElement

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:35

---

addHighlightedText()

addHighlightedText(text): AbstractMarkdownElementContainer

Parameters

Parameter	Type
text	string

Returns

AbstractMarkdownElementContainer

Inherited from

AbstractMarkdownElementContainer.addHighlightedText

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:77

---

addText()

addText(text): AbstractMarkdownElementContainer

Parameters

Parameter	Type
text	string

Returns

AbstractMarkdownElementContainer

Inherited from

AbstractMarkdownElementContainer.addText

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:45

---

addUnderlinedText()

addUnderlinedText(text): AbstractMarkdownElementContainer

Parameters

Parameter	Type
text	string

Returns

AbstractMarkdownElementContainer

Inherited from

AbstractMarkdownElementContainer.addUnderlinedText

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:69

---

createBlockQuote()

createBlockQuote(): BlockQuoteElement

Returns

BlockQuoteElement

Inherited from

AbstractMarkdownElementContainer.createBlockQuote

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:109

---

createCallout()

createCallout(title, type, args): CalloutElement

Parameters

Parameter	Type	Default value
title	string	undefined
type	string	undefined
args	string	''

Returns

CalloutElement

Inherited from

AbstractMarkdownElementContainer.createCallout

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:115

---

createCodeBlock()

createCodeBlock(language, content): CodeBlockElement

Parameters

Parameter	Type
language	string
content	string

Returns

CodeBlockElement

Inherited from

AbstractMarkdownElementContainer.createCodeBlock

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:131

---

createCollapsibleCallout()

createCollapsibleCallout(title, type, args, collapsed): CalloutElement

Parameters

Parameter	Type	Default value
title	string	undefined
type	string	undefined
args	string	''
collapsed	boolean	false

Returns

CalloutElement

Inherited from

AbstractMarkdownElementContainer.createCollapsibleCallout

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:123

---

createHeading()

createHeading(level, content): HeadingElement

Parameters

Parameter	Type
level	number
content	string

Returns

HeadingElement

Inherited from

AbstractMarkdownElementContainer.createHeading

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:101

---

createList()

createList(ordered): ListElement

Parameters

Parameter	Type	Default value
ordered	boolean	false

Returns

ListElement

Inherited from

AbstractMarkdownElementContainer.createList

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:147

---

createOrderedList()

createOrderedList(): ListElement

Returns

ListElement

Inherited from

AbstractMarkdownElementContainer.createOrderedList

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:155

---

createParagraph()

createParagraph(content): ParagraphElement

Parameters

Parameter	Type
content	string

Returns

ParagraphElement

Inherited from

AbstractMarkdownElementContainer.createParagraph

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:93

---

createTable()

createTable(header, body): TableElement

Parameters

Parameter	Type
header	string[]
body	string[][]

Returns

TableElement

Inherited from

AbstractMarkdownElementContainer.createTable

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:139

---

toMarkdown()

toMarkdown(): MarkdownString

Converts the element to a MarkdownString.

Returns

MarkdownString

Inherited from

AbstractMarkdownElementContainer.toMarkdown

Defined in

jsEngine/api/markdown/AbstractMarkdownElement.ts:28

---

toString()

toString(): string

Converts the element to a string.

Returns

string

Overrides

AbstractMarkdownElementContainer.toString

Defined in

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:368