ObsAPI

Defined in: packages/obsidian/src/ObsAPI.ts:38

Meta Bind API for Obsidian.

Extends

• API<ObsComponents>

Constructors

new ObsAPI()

new ObsAPI(mb): ObsAPI

Defined in: packages/obsidian/src/ObsAPI.ts:42

Parameters

Parameter	Type
mb	ObsMetaBind

Returns

ObsAPI

Overrides

API<ObsComponents>.constructor

Properties

mb

readonly mb: MetaBind<ObsComponents>

Defined in: packages/core/src/api/API.ts:63

Inherited from

API.mb

Methods

constructMDRCWidget()

constructMDRCWidget(inlineFieldType, content, filePath, component): MarkdownRenderChildWidget

Defined in: packages/obsidian/src/ObsAPI.ts:88

Creates a CM6 widget from a given widget type.

This is only useful for use in a CodeMirror plugin.

Parameters

Parameter	Type	Description
inlineFieldType	InlineFieldType
content	string
filePath	string
component	Component

Returns

MarkdownRenderChildWidget

---

createBindTarget()

createBindTarget(storageType, storagePath, property, listenToChildren): BindTargetDeclaration

Defined in: packages/core/src/api/API.ts:591

Creates a bind target declaration.

Parameters

Parameter	Type	Default value	Description
storageType	string	undefined	the storage type (also named metadata source sometimes)
storagePath	string	undefined	the storage path (usually the file path)
property	string[]	undefined	the property access path as an array. E.g. for the path cache.a.b.c, the array would be ['a', 'b', 'c'].
listenToChildren	boolean	false	whether to listen to children, only relevant for arrays and objects

Returns

BindTargetDeclaration

Inherited from

API.createBindTarget

---

createButtonGroupMountable()

createButtonGroupMountable(filePath, options): ButtonGroupMountable

Defined in: packages/core/src/api/API.ts:386

Creates a button group from an options object.

Parameters

Parameter	Type	Description
filePath	string	the file path that the field is located in or an empty string
options	ButtonGroupOptions

Returns

ButtonGroupMountable

Inherited from

API.createButtonGroupMountable

---

createButtonMountable()

createButtonMountable(filePath, options): ButtonMountable

Defined in: packages/core/src/api/API.ts:423

Creates a button from an options object.

Parameters

Parameter	Type	Description
filePath	string	the file path that the field is located in or an empty string
options	ButtonOptions

Returns

ButtonMountable

Inherited from

API.createButtonMountable

---

createEmbedMountable()

createEmbedMountable(filePath, options): EmbedMountable

Defined in: packages/core/src/api/API.ts:453

Creates a meta bind embed fields from an options object.

Parameters

Parameter	Type	Description
filePath	string	the file path that the field is located in or an empty string
options	EmbedOptions

Returns

EmbedMountable

Inherited from

API.createEmbedMountable

---

createExcludedMountable()

createExcludedMountable(filePath): ExcludedMountable

Defined in: packages/core/src/api/API.ts:474

Creates an excluded notification mountable for the excluded folders setting.

Parameters

Parameter	Type	Description
filePath	string	the file path that the field is located in or an empty string

Returns

ExcludedMountable

Inherited from

API.createExcludedMountable

---

createField()

createField<Type>(type, filePath, options, honorExcludedSetting): FieldMountable

Defined in: packages/core/src/api/API.ts:77

Creates a field of a given type.

Type Parameters

Type Parameter
Type extends FieldType

Parameters

Parameter	Type	Default value	Description
type	Type	undefined	the type of the field
filePath	string	undefined	the file path that the field is located in, or an empty string if it is not in a file
options	FieldOptionMap[Type]	undefined
honorExcludedSetting	boolean	true	whether to honor the excluded folders settings for this field

Returns

FieldMountable

Inherited from

API.createField

---

createInlineFieldFromString()

createInlineFieldFromString(fieldString, filePath, scope, renderChildType, position?, honorExcludedSetting?): FieldMountable

Defined in: packages/core/src/api/API.ts:137

Creates an inline field from a string. Will throw an error if the string is not a valid declaration.

Parameters

Parameter	Type	Default value	Description
fieldString	string	undefined	the declaration string of the field
filePath	string	undefined	the file path that the field is located in
scope	undefined | BindTargetScope	undefined	optional bind target scope
renderChildType	RenderChildType	RenderChildType.INLINE	the render child type, default INLINE
position?	NotePosition	undefined	an optional note position
honorExcludedSetting?	boolean	true	whether to honor the excluded folders settings for this field

Returns

FieldMountable

Inherited from

API.createInlineFieldFromString

---

createInlineFieldOfTypeFromString()

createInlineFieldOfTypeFromString(type, declaration, filePath, scope, renderChildType, position?, honorExcludedSetting?): FieldMountable

Defined in: packages/core/src/api/API.ts:194

Creates an inline field of a given type and string. Will throw an error if the string is not a valid inline field type.

Parameters

Parameter	Type	Default value	Description
type	InlineFieldType	undefined	the field type
declaration	string	undefined	the declaration string of the field
filePath	string	undefined	the file path that the field is located in
scope	undefined | BindTargetScope	undefined	optional bind target scope
renderChildType	RenderChildType	RenderChildType.INLINE	the render child type, default INLINE
position?	NotePosition	undefined	an optional note position
honorExcludedSetting?	boolean	true	whether to honor the excluded folders settings for this field

Returns

FieldMountable

Inherited from

API.createInlineFieldOfTypeFromString

---

createInputFieldMountable()

createInputFieldMountable(filePath, options): InputFieldMountable

Defined in: packages/core/src/api/API.ts:265

Creates an input field from an options object.

Parameters

Parameter	Type	Description
filePath	string	the file path that the field is located in or an empty string
options	InputFieldOptions

Returns

InputFieldMountable

Inherited from

API.createInputFieldMountable

---

createJsViewFieldMountable()

createJsViewFieldMountable(filePath, options): JsViewFieldMountable

Defined in: packages/core/src/api/API.ts:333

Creates a JS view field from an options object.

Parameters

Parameter	Type	Description
filePath	string	the file path that the field is located in or an empty string
options	JsViewFieldOptions

Returns

JsViewFieldMountable

Inherited from

API.createJsViewFieldMountable

---

createNotePosition()

createNotePosition(lineStart, lineEnd): NotePosition

Defined in: packages/core/src/api/API.ts:763

Creates a note position from a line start and line end number.

Parameters

Parameter	Type	Description
lineStart	number
lineEnd	number

Returns

NotePosition

Inherited from

API.createNotePosition

---

createSignal()

createSignal<T>(value): Signal<T>

Defined in: packages/core/src/api/API.ts:579

Creates a signal.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
value	T

Returns

Signal<T>

Inherited from

API.createSignal

---

createTableMountable()

createTableMountable(filePath, options): TableMountable

Defined in: packages/core/src/api/API.ts:363

Creates a table from an options object.

Parameters

Parameter	Type	Description
filePath	string	the file path that the field is located in or an empty string
options	TableOptions

Returns

TableMountable

Inherited from

API.createTableMountable

---

createViewFieldMountable()

createViewFieldMountable(filePath, options): ViewFieldMountable

Defined in: packages/core/src/api/API.ts:299

Creates a view field from an options object.

Parameters

Parameter	Type	Description
filePath	string	the file path that the field is located in or an empty string
options	ViewFieldOptions

Returns

ViewFieldMountable

Inherited from

API.createViewFieldMountable

---

getInlineFieldDeclarationPrefix()

getInlineFieldDeclarationPrefix(fieldType): string

Defined in: packages/core/src/api/API.ts:493

Gets the prefix of a given widget type. (e.g. INPUT or VIEW).

Parameters

Parameter	Type	Description
fieldType	FieldType

Returns

string

Inherited from

API.getInlineFieldDeclarationPrefix

---

getMetadata()

getMetadata(bindTarget): unknown

Defined in: packages/core/src/api/API.ts:673

Reads a property from meta binds metadata cache. If the value is not present in the cache, it will check the underlying source. E.g. Obsidians metadata cache.

Parameters

Parameter	Type	Description
bindTarget	BindTargetDeclaration

Returns

unknown

Inherited from

API.getMetadata

---

isInlineFieldDeclaration()

isInlineFieldDeclaration(fieldType, str): boolean

Defined in: packages/core/src/api/API.ts:524

Checks if a string is a declaration of a given widget type.

Parameters

Parameter	Type	Description
fieldType	FieldType
str	string	the declaration string

Returns

boolean

Inherited from

API.isInlineFieldDeclaration

---

isInlineFieldDeclarationAndGetType()

isInlineFieldDeclarationAndGetType(str): undefined | InlineFieldType

Defined in: packages/core/src/api/API.ts:547

Checks if a string is any declaration. If yes, it returns the widget type, otherwise undefined.

Parameters

Parameter	Type	Description
str	string	the declaration string

Returns

undefined | InlineFieldType

Inherited from

API.isInlineFieldDeclarationAndGetType

---

mathJSImport()

mathJSImport(object, options?): void

Defined in: packages/core/src/api/API.ts:785

Import new definitions into the internal mathJS instance. For details on how to use, see https://mathjs.org/docs/reference/functions/import.html

Parameters

Parameter	Type
object	ImportObject | ImportObject[]
options?	ImportOptions

Returns

void

Inherited from

API.mathJSImport

---

parseBindTarget()

parseBindTarget(declarationString, filePath, scope?): BindTargetDeclaration

Defined in: packages/core/src/api/API.ts:627

Parses a bind target declaration from a string.

Parameters

Parameter	Type	Description
declarationString	string	the string to parse
filePath	string	the file path that this bind target is relative to
scope?	BindTargetScope	optional bind target scope

Returns

BindTargetDeclaration

Inherited from

API.parseBindTarget

---

reactiveMetadata()

reactiveMetadata(bindTargets, lifecycleHook, callback): ReactiveComponent

Defined in: packages/obsidian/src/ObsAPI.ts:114

Creates a JS Engine reactive component that will re-render when the given bind targets change.

This requires JS Engine to be installed and enabled!

Parameters

Parameter	Type	Description
bindTargets	BindTargetDeclaration[]	the bind targets to listen to
lifecycleHook	LifecycleHook	a Component
callback	(…values) => Promise<unknown>	the callback to call with all the values of the bind targets when one of them changes. What ever this callback returns will be rendered by the reactive component.

Returns

ReactiveComponent

---

setMetadata()

setMetadata(bindTarget, value): void

Defined in: packages/core/src/api/API.ts:654

Sets a property in meta binds metadata cache.

Parameters

Parameter	Type	Description
bindTarget	BindTargetDeclaration
value	unknown

Returns

void

Inherited from

API.setMetadata

---

subscribeToMetadata()

subscribeToMetadata(bindTarget, lifecycleHook, callback): void

Defined in: packages/core/src/api/API.ts:723

Subscribes to a property in meta binds metadata cache. This expects some sort of lifecycle hook to be passed in. This method will register a callback to the lifecycle hook. To unsubscribe the subscription, the callback registered to the lifecycle hook must be called. In the context of Obsidian, you should pass a Component instance as the lifecycle hook and make sure to unload the component when you are done using the metadata subscription.

NOT UNSUBSCRIBING WILL LEAD TO MEMORY LEAKS.

Parameters

Parameter	Type	Description
bindTarget	BindTargetDeclaration
lifecycleHook	LifecycleHook	In Obsidian this is an instance of the Component class. The subscription will be automatically unsubscribed when the component is unloaded.
callback	(value) => void

Returns

void

Inherited from

API.subscribeToMetadata

---

updateMetadata()

updateMetadata(bindTarget, updateFn): void

Defined in: packages/core/src/api/API.ts:692

Updates a property in meta binds metadata cache.

Parameters

Parameter	Type	Description
bindTarget	BindTargetDeclaration
updateFn	(value) => unknown	a function that takes the current value and returns the new value

Returns

void

Inherited from

API.updateMetadata

---

wrapInMDRC()

wrapInMDRC(mountable, containerEl, component): MountableMDRC

Defined in: packages/obsidian/src/ObsAPI.ts:58

Wraps any mountable in a MarkdownRenderChild and adds it as a child to the passed in ComponentLike.

A ComponentLike is either a Component or a MarkdownPostProcessorContext

Parameters

Parameter	Type	Description
mountable	Mountable	the mountable to wrap in a MarkdownRenderChild
containerEl	HTMLElement	the element to mount the MarkdownRenderChild to
component	ComponentLike	the ComponentLike to register the MarkdownRenderChild to

Returns

MountableMDRC