Skip to content
Lapis Notes Lapis Notes

ItemView

Abstract Class: ItemView

Section titled “Abstract Class: ItemView”

Defined in: view.svelte.ts:382

View base class with an action bar and content area.

Extends

Section titled “Extends”

Extended by

Section titled “Extended by”

Constructors

Section titled “Constructors”

Constructor

Section titled “Constructor”

new ItemView(leaf?): ItemView

Defined in: view.svelte.ts:390

Parameters

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

WorkspaceLeaf

Returns

Section titled “Returns”

ItemView

Overrides

Section titled “Overrides”

View.constructor

Properties

Section titled “Properties”

actions

Section titled “actions”

actions: object[]

Defined in: view.svelte.ts:383

callback

Section titled “callback”

callback: (evt) => any

Parameters
Section titled “Parameters”
evt
Section titled “evt”

MouseEvent

Returns
Section titled “Returns”

any

disabled?

Section titled “disabled?”

optional disabled?: boolean

icon

Section titled “icon”

icon: string

title

Section titled “title”

title: string

children

Section titled “children”

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

Defined in: view.svelte.ts:32

Inherited from

Section titled “Inherited from”

View.children

icon

Section titled “icon”

icon: string = ""

Defined in: view.svelte.ts:278

Inherited from

Section titled “Inherited from”

View.icon

leaf

Section titled “leaf”

leaf: WorkspaceLeaf

Defined in: view.svelte.ts:279

Inherited from

Section titled “Inherited from”

View.leaf

loaded

Section titled “loaded”

loaded: boolean = false

Defined in: view.svelte.ts:34

Inherited from

Section titled “Inherited from”

View.loaded

scope

Section titled “scope”

scope: Scope | null = null

Defined in: view.svelte.ts:280

Inherited from

Section titled “Inherited from”

View.scope

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

Inherited from

Section titled “Inherited from”

View.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

Inherited from

Section titled “Inherited from”

View.containerEl

contentEl

Section titled “contentEl”

Get Signature

Section titled “Get Signature”

get contentEl(): HTMLElement

Defined in: view.svelte.ts:394

Returns
Section titled “Returns”

HTMLElement

Methods

Section titled “Methods”

addAction()

Section titled “addAction()”

addAction(icon, title, callback, options?): void

Defined in: view.svelte.ts:402

Parameters

Section titled “Parameters”
icon
Section titled “icon”

string

title
Section titled “title”

string

callback
Section titled “callback”

(evt) => any

options?
Section titled “options?”
disabled?
Section titled “disabled?”

boolean

Returns

Section titled “Returns”

void

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”

View.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”

View.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”

View.emit

getDisplayText()

Section titled “getDisplayText()”

abstract getDisplayText(): string

Defined in: view.svelte.ts:322

Returns

Section titled “Returns”

string

Inherited from

Section titled “Inherited from”

View.getDisplayText

getIcon()

Section titled “getIcon()”

getIcon(): string

Defined in: view.svelte.ts:318

Returns

Section titled “Returns”

string

Inherited from

Section titled “Inherited from”

View.getIcon

getState()

Section titled “getState()”

getState(): Record<string, unknown>

Defined in: view.svelte.ts:306

Returns

Section titled “Returns”

Record<string, unknown>

Inherited from

Section titled “Inherited from”

View.getState

getViewType()

Section titled “getViewType()”

abstract getViewType(): string

Defined in: view.svelte.ts:304

Returns

Section titled “Returns”

string

Inherited from

Section titled “Inherited from”

View.getViewType

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”

View.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”

View.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”

View.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”

View.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”

View.once

onClose()

Section titled “onClose()”

onClose(): Promise<void>

Defined in: view.svelte.ts:415

Returns

Section titled “Returns”

Promise<void>

Overrides

Section titled “Overrides”

View.onClose

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”

View.onload

onOpen()

Section titled “onOpen()”

onOpen(): Promise<void>

Defined in: view.svelte.ts:411

Returns

Section titled “Returns”

Promise<void>

Overrides

Section titled “Overrides”

View.onOpen

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

Inherited from

Section titled “Inherited from”

View.onPaneMenu

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”

View.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”

View.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”

View.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”

View.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”

View.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”

View.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”

View.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”

View.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>

Inherited from

Section titled “Inherited from”

View.setState

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”

View.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”

View.tryTrigger

unload()

Section titled “unload()”

unload(): void

Defined in: view.svelte.ts:398

Unload this component and its children

Returns

Section titled “Returns”

void

Overrides

Section titled “Overrides”

View.unload