PublishPlugin
Extends
Properties
_children
_children:
Component[]
Child Components attached to current component, will be unloaded on unloading parent component
Inherited from
_events
_events:
EventRef[]
Events that are attached to the current component, will be detached on unloading parent component
Inherited from
_loaded
_loaded:
boolean
Whether the component and its children are loaded
Inherited from
addedButtonEls
addedButtonEls:
HTMLDivElement[]
Inherited from
app
app:
App
Inherited from
commands
commands:
Command[]
Inherited from
enabled
enabled:
boolean
Inherited from
hasStatusBarItem
hasStatusBarItem:
boolean
Inherited from
InternalPlugin.hasStatusBarItem
instance
instance:
PublishPluginInstance
Inherited from
lastSave
lastSave:
number
Inherited from
manager
manager:
InternalPlugins
Inherited from
mobileFileInfo
mobileFileInfo:
MobileFileInfo[]
Inherited from
onConfigFileChange
Inherited from
InternalPlugin.onConfigFileChange
ribbonItems
ribbonItems:
RibbonItem[]
Inherited from
statusBarEl
statusBarEl:
null|HTMLDivElement
Inherited from
views
views:
Record<string,ViewCreator>
Inherited from
Methods
addChild()
addChild<
T>(component):T
Adds a child component, loading it if this component is loaded
Type Parameters
• T extends Component
Parameters
• component: T
Returns
T
Inherited from
addSettingTab()
addSettingTab(
settingTab):void
Parameters
• settingTab: PluginSettingTab
Returns
void
Inherited from
deleteData()
deleteData():
Promise<void>
Returns
Promise<void>
Inherited from
disable()
disable(
isDisabledByUser?):void
Parameters
• isDisabledByUser?: boolean
Returns
void
Inherited from
enable()
enable(
isEnabledByUser?):Promise<void>
Parameters
• isEnabledByUser?: boolean
Returns
Promise<void>
Inherited from
getModifiedTime()
getModifiedTime():
Promise<undefined|number>
Returns
Promise<undefined | number>
Inherited from
InternalPlugin.getModifiedTime
handleConfigFileChange()
handleConfigFileChange():
Promise<void>
Returns
Promise<void>
Inherited from
InternalPlugin.handleConfigFileChange
init()
init():
void
Returns
void
Inherited from
load()
load():
void
Load this component and its children
Returns
void
Inherited from
loadData()
loadData():
Promise<null|object>
Returns
Promise<null | object>
Inherited from
onload()
onload():
void
Override this to load your component
Returns
void
Inherited from
onunload()
onunload():
void
Override this to unload your component
Returns
void
Inherited from
register()
register(
cb):void
Registers a callback to be called when unloading
Parameters
• cb
Returns
void
Inherited from
registerDomEvent()
registerDomEvent(el, type, callback, options)
registerDomEvent<
K>(el,type,callback,options?):void
Registers an DOM event to be detached when unloading
Type Parameters
• K extends keyof WindowEventMap
Parameters
• el: Window
• type: K
• callback
• options?: boolean | AddEventListenerOptions
Returns
void
Inherited from
InternalPlugin.registerDomEvent
registerDomEvent(el, type, callback, options)
registerDomEvent<
K>(el,type,callback,options?):void
Registers an DOM event to be detached when unloading
Type Parameters
• K extends keyof DocumentEventMap
Parameters
• el: Document
• type: K
• callback
• options?: boolean | AddEventListenerOptions
Returns
void
Inherited from
InternalPlugin.registerDomEvent
registerDomEvent(el, type, callback, options)
registerDomEvent<
K>(el,type,callback,options?):void
Registers an DOM event to be detached when unloading
Type Parameters
• K extends keyof HTMLElementEventMap
Parameters
• el: HTMLElement
• type: K
• callback
• options?: boolean | AddEventListenerOptions
Returns
void
Inherited from
InternalPlugin.registerDomEvent
registerEvent()
registerEvent(
eventRef):void
Registers an event to be detached when unloading
Parameters
• eventRef: EventRef
Returns
void
Inherited from
registerGlobalCommand()
registerGlobalCommand(
command):void
Parameters
• command: Command
Returns
void
Inherited from
InternalPlugin.registerGlobalCommand
registerInterval()
registerInterval(
id):number
Registers an interval (from setInterval) to be cancelled when unloading Use setInterval instead of setInterval to avoid TypeScript confusing between NodeJS vs Browser API
Parameters
• id: number
Returns
number
Inherited from
InternalPlugin.registerInterval
registerMobileFileInfo()
registerMobileFileInfo(
renderCallback):void
Parameters
• renderCallback
Returns
void
Inherited from
InternalPlugin.registerMobileFileInfo
registerRibbonItem()
registerRibbonItem(
title,icon,callback):void
Parameters
• title: string
• icon: string
• callback
Returns
void
Inherited from
InternalPlugin.registerRibbonItem
registerScopeEvent()
registerScopeEvent(
keymapEventHandler):void
Parameters
• keymapEventHandler: KeymapEventHandler
Returns
void
Inherited from
InternalPlugin.registerScopeEvent
registerStatusBarItem()
registerStatusBarItem():
void
Returns
void
Inherited from
InternalPlugin.registerStatusBarItem
registerViewType()
registerViewType(
type,creator):void
Parameters
• type: string
• creator: ViewCreator
Returns
void
Inherited from
InternalPlugin.registerViewType
removeChild()
removeChild<
T>(component):T
Removes a child component, unloading it
Type Parameters
• T extends Component
Parameters
• component: T
Returns
T
Inherited from
saveData()
saveData(
data):Promise<void>
Parameters
• data: object
Returns
Promise<void>
Inherited from
unload()
unload():
void
Unload this component and its children
Returns
void