EmbedContext

Defined in: src/obsidian/internals/EmbedRegistry/EmbedContext.d.ts:9

A context to configure embedding of a file.

Unofficial

Properties

app

app: App

Defined in: src/obsidian/internals/EmbedRegistry/EmbedContext.d.ts:13

Reference to the app.

---

containerEl

containerEl: HTMLElement

Defined in: src/obsidian/internals/EmbedRegistry/EmbedContext.d.ts:18

Element where the embed should be displayed.

---

depth?

optional depth: number

Defined in: src/obsidian/internals/EmbedRegistry/EmbedContext.d.ts:23

Depth of the embed within its container (how many levels of embeds are above it).

---

displayMode?

optional displayMode: boolean

Defined in: src/obsidian/internals/EmbedRegistry/EmbedContext.d.ts:28

Whether the embed should be dynamic (CM) or static (postProcessed).

---

linktext?

optional linktext: string

Defined in: src/obsidian/internals/EmbedRegistry/EmbedContext.d.ts:33

Text that should be displayed in the embed.

---

showInline?

optional showInline: boolean

Defined in: src/obsidian/internals/EmbedRegistry/EmbedContext.d.ts:38

Whether the embed should be an inline embed.

---

sourcePath?

optional sourcePath: string

Defined in: src/obsidian/internals/EmbedRegistry/EmbedContext.d.ts:43

Optional path to the current open file.

---

state?

optional state: unknown

Defined in: src/obsidian/internals/EmbedRegistry/EmbedContext.d.ts:46

Todo

Documentation incomplete.