FileView
Abstract Class: FileView
Section titled “Abstract Class: FileView”Defined in: view.svelte.ts:425
Item view base class that is backed by a vault file.
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FileView(
leaf?):FileView
Defined in: view.svelte.ts:428
Parameters
Section titled “Parameters”Returns
Section titled “Returns”FileView
Overrides
Section titled “Overrides”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”MouseEvent
Returns
Section titled “Returns”any
disabled?
Section titled “disabled?”
optionaldisabled?:boolean
icon:
string
title:
string
Inherited from
Section titled “Inherited from”children
Section titled “children”children:
Component<Record<string,any>>[] =[]
Defined in: view.svelte.ts:32
Inherited from
Section titled “Inherited from”file:
TFile|null
Defined in: view.svelte.ts:426
icon:
string=""
Defined in: view.svelte.ts:278
Inherited from
Section titled “Inherited from”leaf:
WorkspaceLeaf
Defined in: view.svelte.ts:279
Inherited from
Section titled “Inherited from”loaded
Section titled “loaded”loaded:
boolean=false
Defined in: view.svelte.ts:34
Inherited from
Section titled “Inherited from”scope:
Scope|null=null
Defined in: view.svelte.ts:280
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get app():
App
Defined in: view.svelte.ts:295
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”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”contentEl
Section titled “contentEl”Get Signature
Section titled “Get Signature”get contentEl():
HTMLElement
Defined in: view.svelte.ts:394
Returns
Section titled “Returns”HTMLElement
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”addAction()
Section titled “addAction()”addAction(
icon,title,callback,options?):void
Defined in: view.svelte.ts:402
Parameters
Section titled “Parameters”string
string
callback
Section titled “callback”(evt) => any
options?
Section titled “options?”disabled?
Section titled “disabled?”boolean
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”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 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”canAcceptExtension()
Section titled “canAcceptExtension()”
abstractcanAcceptExtension(extension):boolean
Defined in: view.svelte.ts:438
Parameters
Section titled “Parameters”extension
Section titled “extension”string
Returns
Section titled “Returns”boolean
dispatch()
Section titled “dispatch()”dispatch<
T>(eventName, …args):boolean
Defined in: events.ts:105
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…any[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”emit()
Section titled “emit()”emit<
T>(eventName, …args):boolean
Defined in: events.ts:98
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…any[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”getDisplayText()
Section titled “getDisplayText()”
abstractgetDisplayText():string
Defined in: view.svelte.ts:322
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”getIcon()
Section titled “getIcon()”getIcon():
string
Defined in: view.svelte.ts:318
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”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”getViewType()
Section titled “getViewType()”
abstractgetViewType():string
Defined in: view.svelte.ts:304
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”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”off<
T>(eventName,listener,context?,once?):void
Defined in: events.ts:78
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
listener
Section titled “listener”(…args) => void
context?
Section titled “context?”any
boolean
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”offref()
Section titled “offref()”offref<
T>(ref):void
Defined in: events.ts:87
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”EventRef<Record<string, any>, T>
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”on<
T>(eventName,listener,context?):EventRef<Record<string,any>,T,any>
Defined in: events.ts:48
Type Parameters
Section titled “Type Parameters”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”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 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”onClose()
Section titled “onClose()”onClose():
Promise<void>
Defined in: view.svelte.ts:415
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”onload()
Section titled “onload()”
abstractonload():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”onLoadFile()
Section titled “onLoadFile()”
abstractonLoadFile(file):Promise<void>
Defined in: view.svelte.ts:432
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
onOpen()
Section titled “onOpen()”onOpen():
Promise<void>
Defined in: view.svelte.ts:411
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”onPaneMenu()
Section titled “onPaneMenu()”onPaneMenu(
menu,source):void
Defined in: view.svelte.ts:324
Parameters
Section titled “Parameters”source
Section titled “source”string
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”onRename()
Section titled “onRename()”
abstractonRename(file):Promise<void>
Defined in: view.svelte.ts:436
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
onunload()
Section titled “onunload()”
abstractonunload():void
Defined in: view.svelte.ts:122
Override this to unload your component
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”onUnloadFile()
Section titled “onUnloadFile()”
abstractonUnloadFile(file):Promise<void>
Defined in: view.svelte.ts:434
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
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”() => any
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”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 extends keyof HTMLElementEventMap
Parameters
Section titled “Parameters”HTMLElement
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”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 extends keyof DocumentEventMap
Parameters
Section titled “Parameters”Document
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”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 extends keyof WindowEventMap
Parameters
Section titled “Parameters”Window
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”registerEvent()
Section titled “registerEvent()”registerEvent<
T,K>(eventRef):void
Defined in: view.svelte.ts:193
Type Parameters
Section titled “Type Parameters”T extends ValidEventTypes
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”registerInterval()
Section titled “registerInterval()”registerInterval(
id):void
Defined in: view.svelte.ts:199
Parameters
Section titled “Parameters”Timeout
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”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 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”setState()
Section titled “setState()”setState(
state,result?):Promise<void>
Defined in: view.svelte.ts:310
Parameters
Section titled “Parameters”Record<string, unknown>
result?
Section titled “result?”Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”trigger()
Section titled “trigger()”trigger<
T>(eventName, …args):boolean
Defined in: events.ts:91
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…any[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”tryTrigger()
Section titled “tryTrigger()”tryTrigger<
T>(evt, …args):void
Defined in: events.ts:112
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”EventRef<Record<string, any>, T>
…any[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”unload()
Section titled “unload()”unload():
void
Defined in: view.svelte.ts:398
Unload this component and its children
Returns
Section titled “Returns”void