CalloutElement

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:395

Represents a markdown callout.

Extends

• AbstractMarkdownElementContainer

Constructors

new CalloutElement()

new CalloutElement(apiInstance, title, type, args, collapsible, collapsed): CalloutElement

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:402

Parameters

Parameter	Type	Default value
apiInstance	API	undefined
title	string	undefined
type	string	undefined
args	string	undefined
collapsible	boolean	false
collapsed	boolean	false

Returns

CalloutElement

Overrides

AbstractMarkdownElementContainer.constructor

Properties

apiInstance

readonly apiInstance: API

Defined in: jsEngine/api/markdown/AbstractMarkdownElement.ts:9

Inherited from

AbstractMarkdownElementContainer.apiInstance

---

args

args: string

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:398

---

collapsed

collapsed: boolean

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:400

---

collapsible

collapsible: boolean

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:399

---

markdownElements

markdownElements: AbstractMarkdownElement[]

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:12

Inherited from

AbstractMarkdownElementContainer.markdownElements

---

title

title: string

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:396

---

type

type: string

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:397

Methods

addBoldText()

addBoldText(text): AbstractMarkdownElementContainer

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:53

Parameters

Parameter	Type
text	string

Returns

AbstractMarkdownElementContainer

Inherited from

AbstractMarkdownElementContainer.addBoldText

---

addCode()

addCode(text): AbstractMarkdownElementContainer

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:85

Parameters

Parameter	Type
text	string

Returns

AbstractMarkdownElementContainer

Inherited from

AbstractMarkdownElementContainer.addCode

---

addCursiveText()

addCursiveText(text): AbstractMarkdownElementContainer

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:61

Parameters

Parameter	Type
text	string

Returns

AbstractMarkdownElementContainer

Inherited from

AbstractMarkdownElementContainer.addCursiveText

---

addElement()

addElement(element): void

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:35

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

---

addHighlightedText()

addHighlightedText(text): AbstractMarkdownElementContainer

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:77

Parameters

Parameter	Type
text	string

Returns

AbstractMarkdownElementContainer

Inherited from

AbstractMarkdownElementContainer.addHighlightedText

---

addText()

addText(text): AbstractMarkdownElementContainer

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:45

Parameters

Parameter	Type
text	string

Returns

AbstractMarkdownElementContainer

Inherited from

AbstractMarkdownElementContainer.addText

---

addUnderlinedText()

addUnderlinedText(text): AbstractMarkdownElementContainer

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:69

Parameters

Parameter	Type
text	string

Returns

AbstractMarkdownElementContainer

Inherited from

AbstractMarkdownElementContainer.addUnderlinedText

---

createBlockQuote()

createBlockQuote(): BlockQuoteElement

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:109

Returns

BlockQuoteElement

Inherited from

AbstractMarkdownElementContainer.createBlockQuote

---

createCallout()

createCallout(title, type, args): CalloutElement

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:115

Parameters

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

Returns

CalloutElement

Inherited from

AbstractMarkdownElementContainer.createCallout

---

createCodeBlock()

createCodeBlock(language, content): CodeBlockElement

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:131

Parameters

Parameter	Type
language	string
content	string

Returns

CodeBlockElement

Inherited from

AbstractMarkdownElementContainer.createCodeBlock

---

createCollapsibleCallout()

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

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:123

Parameters

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

Returns

CalloutElement

Inherited from

AbstractMarkdownElementContainer.createCollapsibleCallout

---

createHeading()

createHeading(level, content): HeadingElement

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:101

Parameters

Parameter	Type
level	number
content	string

Returns

HeadingElement

Inherited from

AbstractMarkdownElementContainer.createHeading

---

createList()

createList(ordered): ListElement

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:147

Parameters

Parameter	Type	Default value
ordered	boolean	false

Returns

ListElement

Inherited from

AbstractMarkdownElementContainer.createList

---

createOrderedList()

createOrderedList(): ListElement

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:155

Returns

ListElement

Inherited from

AbstractMarkdownElementContainer.createOrderedList

---

createParagraph()

createParagraph(content): ParagraphElement

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:93

Parameters

Parameter	Type
content	string

Returns

ParagraphElement

Inherited from

AbstractMarkdownElementContainer.createParagraph

---

createTable()

createTable(header, body): TableElement

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:139

Parameters

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

Returns

TableElement

Inherited from

AbstractMarkdownElementContainer.createTable

---

toMarkdown()

toMarkdown(): MarkdownString

Defined in: jsEngine/api/markdown/AbstractMarkdownElement.ts:28

Converts the element to a MarkdownString.

Returns

MarkdownString

Inherited from

AbstractMarkdownElementContainer.toMarkdown

---

toString()

toString(): string

Defined in: jsEngine/api/markdown/AbstractMarkdownElementContainer.ts:412

Converts the element to a string.

Returns

string

Overrides

AbstractMarkdownElementContainer.toString