Skip to content
Lapis Notes Lapis Notes

View

Abstract Class: View

Section titled “Abstract Class: View”

Defined in: view.svelte.ts:277

Base class for anything that can be mounted inside a workspace leaf.

Extends

Section titled “Extends”

Extended by

Section titled “Extended by”

Constructors

Section titled “Constructors”

Constructor

Section titled “Constructor”

new View(leaf?): View

Defined in: view.svelte.ts:283

Parameters

Section titled “Parameters”
leaf?
Section titled “leaf?”

WorkspaceLeaf

Returns

Section titled “Returns”

View

Overrides

Section titled “Overrides”

Component.constructor

Properties

Section titled “Properties”

children

Section titled “children”

children: Component<Record<string, any>>[] = []

Defined in: view.svelte.ts:32

Inherited from

Section titled “Inherited from”

Component.children

icon

Section titled “icon”

icon: string = ""

Defined in: view.svelte.ts:278

leaf

Section titled “leaf”

leaf: WorkspaceLeaf

Defined in: view.svelte.ts:279

loaded

Section titled “loaded”

loaded: boolean = false

Defined in: view.svelte.ts:34

Inherited from

Section titled “Inherited from”

Component.loaded

scope

Section titled “scope”

scope: Scope | null = null

Defined in: view.svelte.ts:280

Accessors

Section titled “Accessors”

app

Section titled “app”

Get Signature

Section titled “Get Signature”

get app(): App

Defined in: view.svelte.ts:295

Returns
Section titled “Returns”

App

containerEl

Section titled “containerEl”

Get Signature

Section titled “Get Signature”

get containerEl(): HTMLElement

Defined in: view.svelte.ts:291

Returns
Section titled “Returns”

HTMLElement

Overrides

Section titled “Overrides”

Component.containerEl

Methods

Section titled “Methods”

addChild()

Section titled “addChild()”

addChild<T>(component): T

Defined in: view.svelte.ts:162

Adds a child component, loading it if this component is loaded

Type Parameters

Section titled “Type Parameters”
T
Section titled “T”

T extends Component<Record<string, any>>

Parameters

Section titled “Parameters”
component
Section titled “component”

T

Returns

Section titled “Returns”

T

Inherited from

Section titled “Inherited from”

Component.addChild

dispatch()

Section titled “dispatch()”

dispatch<T>(eventName, …args): boolean

Defined in: events.ts:105

Type Parameters

Section titled “Type Parameters”
T
Section titled “T”

T extends string

Parameters

Section titled “Parameters”
eventName
Section titled “eventName”

T

args
Section titled “args”

…any[]

Returns

Section titled “Returns”

boolean

Inherited from

Section titled “Inherited from”

Component.dispatch

emit()

Section titled “emit()”

emit<T>(eventName, …args): boolean

Defined in: events.ts:98

Type Parameters

Section titled “Type Parameters”
T
Section titled “T”

T extends string

Parameters

Section titled “Parameters”
eventName
Section titled “eventName”

T

args
Section titled “args”

…any[]

Returns

Section titled “Returns”

boolean

Inherited from

Section titled “Inherited from”

Component.emit

getDisplayText()

Section titled “getDisplayText()”

abstract getDisplayText(): string

Defined in: view.svelte.ts:322

Returns

Section titled “Returns”

string

getIcon()

Section titled “getIcon()”

getIcon(): string

Defined in: view.svelte.ts:318

Returns

Section titled “Returns”

string

getState()

Section titled “getState()”

getState(): Record<string, unknown>

Defined in: view.svelte.ts:306

Returns

Section titled “Returns”

Record<string, unknown>

getViewType()

Section titled “getViewType()”

abstract getViewType(): string

Defined in: view.svelte.ts:304

Returns

Section titled “Returns”

string

load()

Section titled “load()”

load(): void

Defined in: view.svelte.ts:51

Load this component and its children

Returns

Section titled “Returns”

void

Inherited from

Section titled “Inherited from”

Component.load

off()

Section titled “off()”

off<T>(eventName, listener, context?, once?): void

Defined in: events.ts:78

Type Parameters

Section titled “Type Parameters”
T
Section titled “T”

T extends string

Parameters

Section titled “Parameters”
eventName
Section titled “eventName”

T

listener
Section titled “listener”

(…args) => void

context?
Section titled “context?”

any

once?
Section titled “once?”

boolean

Returns

Section titled “Returns”

void

Inherited from

Section titled “Inherited from”

Component.off

offref()

Section titled “offref()”

offref<T>(ref): void

Defined in: events.ts:87

Type Parameters

Section titled “Type Parameters”
T
Section titled “T”

T extends string

Parameters

Section titled “Parameters”
ref
Section titled “ref”

EventRef<Record<string, any>, T>

Returns

Section titled “Returns”

void

Inherited from

Section titled “Inherited from”

Component.offref

on()

Section titled “on()”

on<T>(eventName, listener, context?): EventRef<Record<string, any>, T, any>

Defined in: events.ts:48

Type Parameters

Section titled “Type Parameters”
T
Section titled “T”

T extends string

Parameters

Section titled “Parameters”
eventName
Section titled “eventName”

T

listener
Section titled “listener”

(…args) => void

context?
Section titled “context?”

any

Returns

Section titled “Returns”

EventRef<Record<string, any>, T, any>

Inherited from

Section titled “Inherited from”

Component.on

once()

Section titled “once()”

once<T>(eventName, listener, context?): EventRef<Record<string, any>, T, any>

Defined in: events.ts:63

Type Parameters

Section titled “Type Parameters”
T
Section titled “T”

T extends string

Parameters

Section titled “Parameters”
eventName
Section titled “eventName”

T

listener
Section titled “listener”

(…args) => void

context?
Section titled “context?”

any

Returns

Section titled “Returns”

EventRef<Record<string, any>, T, any>

Inherited from

Section titled “Inherited from”

Component.once

onClose()

Section titled “onClose()”

abstract onClose(): Promise<void>

Defined in: view.svelte.ts:302

Returns

Section titled “Returns”

Promise<void>

onload()

Section titled “onload()”

abstract onload(): void | Promise<void>

Defined in: view.svelte.ts:65

Override this to load your component

Returns

Section titled “Returns”

void | Promise<void>

Inherited from

Section titled “Inherited from”

Component.onload

onOpen()

Section titled “onOpen()”

abstract onOpen(): Promise<void>

Defined in: view.svelte.ts:300

Returns

Section titled “Returns”

Promise<void>

onPaneMenu()

Section titled “onPaneMenu()”

onPaneMenu(menu, source): void

Defined in: view.svelte.ts:324

Parameters

Section titled “Parameters”
Section titled “menu”

Menu

source
Section titled “source”

string

Returns

Section titled “Returns”

void

onunload()

Section titled “onunload()”

abstract onunload(): void

Defined in: view.svelte.ts:122

Override this to unload your component

Returns

Section titled “Returns”

void

Inherited from

Section titled “Inherited from”

Component.onunload

register()

Section titled “register()”

register(cb): void

Defined in: view.svelte.ts:189

Registers a callback to be called when unloading

Parameters

Section titled “Parameters”
cb
Section titled “cb”

() => any

Returns

Section titled “Returns”

void

Inherited from

Section titled “Inherited from”

Component.register

registerDomEvent()

Section titled “registerDomEvent()”

Call Signature

Section titled “Call Signature”

registerDomEvent<K>(el, type, callback, options?): void

Defined in: view.svelte.ts:208

Registers an DOM event to be detached when unloading

Type Parameters
Section titled “Type Parameters”
K
Section titled “K”

K extends keyof HTMLElementEventMap

Parameters
Section titled “Parameters”
el
Section titled “el”

HTMLElement

type
Section titled “type”

K

callback
Section titled “callback”

(this, ev) => any

options?
Section titled “options?”

boolean | AddEventListenerOptions

Returns
Section titled “Returns”

void

Inherited from
Section titled “Inherited from”

Component.registerDomEvent

Call Signature

Section titled “Call Signature”

registerDomEvent<K>(el, type, callback, options?): void

Defined in: view.svelte.ts:214

Registers an DOM event to be detached when unloading

Type Parameters
Section titled “Type Parameters”
K
Section titled “K”

K extends keyof DocumentEventMap

Parameters
Section titled “Parameters”
el
Section titled “el”

Document

type
Section titled “type”

K

callback
Section titled “callback”

(this, ev) => any

options?
Section titled “options?”

boolean | AddEventListenerOptions

Returns
Section titled “Returns”

void

Inherited from
Section titled “Inherited from”

Component.registerDomEvent

Call Signature

Section titled “Call Signature”

registerDomEvent<K>(el, type, callback, options?): void

Defined in: view.svelte.ts:220

Registers an DOM event to be detached when unloading

Type Parameters
Section titled “Type Parameters”
K
Section titled “K”

K extends keyof WindowEventMap

Parameters
Section titled “Parameters”
el
Section titled “el”

Window

type
Section titled “type”

K

callback
Section titled “callback”

(this, ev) => any

options?
Section titled “options?”

boolean | AddEventListenerOptions

Returns
Section titled “Returns”

void

Inherited from
Section titled “Inherited from”

Component.registerDomEvent

registerEvent()

Section titled “registerEvent()”

registerEvent<T, K>(eventRef): void

Defined in: view.svelte.ts:193

Type Parameters

Section titled “Type Parameters”
T
Section titled “T”

T extends ValidEventTypes

K
Section titled “K”

K extends string | symbol

Parameters

Section titled “Parameters”
eventRef
Section titled “eventRef”

EventRef<T, K, any>

Returns

Section titled “Returns”

void

Inherited from

Section titled “Inherited from”

Component.registerEvent

registerInterval()

Section titled “registerInterval()”

registerInterval(id): void

Defined in: view.svelte.ts:199

Parameters

Section titled “Parameters”
id
Section titled “id”

Timeout

Returns

Section titled “Returns”

void

Inherited from

Section titled “Inherited from”

Component.registerInterval

removeChild()

Section titled “removeChild()”

removeChild<T>(component): T

Defined in: view.svelte.ts:176

Removes a child component, unloading it

Type Parameters

Section titled “Type Parameters”
T
Section titled “T”

T extends Component<Record<string, any>>

Parameters

Section titled “Parameters”
component
Section titled “component”

T

Returns

Section titled “Returns”

T

Inherited from

Section titled “Inherited from”

Component.removeChild

setState()

Section titled “setState()”

setState(state, result?): Promise<void>

Defined in: view.svelte.ts:310

Parameters

Section titled “Parameters”
state
Section titled “state”

Record<string, unknown>

result?
Section titled “result?”

ViewStateResult

Returns

Section titled “Returns”

Promise<void>

trigger()

Section titled “trigger()”

trigger<T>(eventName, …args): boolean

Defined in: events.ts:91

Type Parameters

Section titled “Type Parameters”
T
Section titled “T”

T extends string

Parameters

Section titled “Parameters”
eventName
Section titled “eventName”

T

args
Section titled “args”

…any[]

Returns

Section titled “Returns”

boolean

Inherited from

Section titled “Inherited from”

Component.trigger

tryTrigger()

Section titled “tryTrigger()”

tryTrigger<T>(evt, …args): void

Defined in: events.ts:112

Type Parameters

Section titled “Type Parameters”
T
Section titled “T”

T extends string

Parameters

Section titled “Parameters”
evt
Section titled “evt”

EventRef<Record<string, any>, T>

args
Section titled “args”

…any[]

Returns

Section titled “Returns”

void

Inherited from

Section titled “Inherited from”

Component.tryTrigger

unload()

Section titled “unload()”

unload(): void

Defined in: view.svelte.ts:92

Unload this component and its children

Returns

Section titled “Returns”

void

Inherited from

Section titled “Inherited from”

Component.unload