Module renderer/types

base.find-in-repository:function

• base.find-in-repository(query?: FindInRepositoryQuery): void

• Parameters

  • Optional query: FindInRepositoryQuery

  Returns void

control-center.refresh:function

• control-center.refresh(): void

• Returns void

control-center.toggle:function

• control-center.toggle(visible?: boolean): void

• Parameters

  • Optional visible: boolean

  Returns void

doc.hide-history:function

• doc.hide-history(): void

• Returns void

doc.show-history:function

• doc.show-history(doc?: Doc): void

• Parameters

  • Optional doc: Doc

  Returns void

editor.refresh-custom-editor:function

• editor.refresh-custom-editor(): void

• Returns void

editor.toggle-wrap:function

• editor.toggle-wrap(): void

• Returns void

editor.trigger-save:function

• editor.trigger-save(): void

• Returns void

extension.show-manager:function

• extension.show-manager(id?: string): void

• Parameters

  • Optional id: string

  Returns void

file-tabs.close-current:function

• file-tabs.close-current(): void

• Returns void

file-tabs.close-tabs:function

• file-tabs.close-tabs(keys: string[]): void

• Parameters

  • keys: string[]

  Returns void

file-tabs.refresh-action-btns:function

• file-tabs.refresh-action-btns(): void

• Returns void

file-tabs.search-tabs:function

• file-tabs.search-tabs(): void

• Returns void

file-tabs.switch-left:function

• file-tabs.switch-left(): void

• Returns void

file-tabs.switch-right:function

• file-tabs.switch-right(): void

• Returns void

filter.choose-document:function

• filter.choose-document(): Promise<Doc>

• Returns Promise<Doc>

keyboard-shortcuts.show-manager:function

• keyboard-shortcuts.show-manager(id?: string): void

• Parameters

  • Optional id: string

  Returns void

layout.toggle-editor:function

• layout.toggle-editor(visible?: boolean): void

• Parameters

  • Optional visible: boolean

  Returns void

layout.toggle-side:function

• layout.toggle-side(visible?: boolean): void

• Parameters

  • Optional visible: boolean

  Returns void

layout.toggle-view:function

• layout.toggle-view(visible?: boolean): void

• Parameters

  • Optional visible: boolean

  Returns void

layout.toggle-xterm:function

• layout.toggle-xterm(visible?: boolean): void

• Parameters

  • Optional visible: boolean

  Returns void

plugin.document-history-stack.back:function

• plugin.document-history-stack.back(): void

• Returns void

plugin.document-history-stack.forward:function

• plugin.document-history-stack.forward(): void

• Returns void

plugin.electron-zoom.zoom-in:function

• plugin.electron-zoom.zoom-in(): void

• Returns void

plugin.electron-zoom.zoom-out:function

• plugin.electron-zoom.zoom-out(): void

• Returns void

plugin.electron-zoom.zoom-reset:function

• plugin.electron-zoom.zoom-reset(): void

• Returns void

plugin.image-hosting-picgo.upload:function

• plugin.image-hosting-picgo.upload(file: File): Promise<undefined | string>

• Parameters

  • file: File

  Returns Promise<undefined | string>

plugin.image-localization.download-all:function

• plugin.image-localization.download-all(): void

• Returns void

plugin.status-bar-help.show-features:function

• plugin.status-bar-help.show-features(): void

• Returns void

plugin.status-bar-help.show-plugin:function

• plugin.status-bar-help.show-plugin(): void

• Returns void

plugin.status-bar-help.show-readme:function

• plugin.status-bar-help.show-readme(): void

• Returns void

plugin.switch-todo.switch:function

• plugin.switch-todo.switch(line?: number, checked?: boolean): void

• Parameters

  • Optional line: number

  • Optional checked: boolean

  Returns void

premium.show:function

• premium.show(tab?: PremiumTab): void

• Parameters

  • Optional tab: PremiumTab

  Returns void

status-bar.refresh-menu:function

• status-bar.refresh-menu(): void

• Returns void

tree.refresh:function

• tree.refresh(): void

• Returns void

tree.reveal-current-node:function

• tree.reveal-current-node(): void

• Returns void

view.enter-presentation:function

• view.enter-presentation(): void

• Returns void

view.exit-presentation:function

• view.exit-presentation(): void

• Returns void

view.get-content-html:function

• view.get-content-html(selected?: boolean): string

• Parameters

  • Optional selected: boolean

  Returns string

view.get-render-env:function

• view.get-render-env(): null | RenderEnv

• Returns null | RenderEnv

view.get-view-dom:function

• view.get-view-dom(): null | HTMLElement

• Returns null | HTMLElement

view.refresh:function

• view.refresh(): void

• Returns void

view.render:function

• view.render(): void

• Returns void

view.render-immediately:function

• view.render-immediately(): void

• Returns void

view.reveal-line:function

• view.reveal-line(startLine: number): Promise<null | HTMLElement>

• Parameters

  • startLine: number

  Returns Promise<null | HTMLElement>

view.show-find-in-preview:function

• view.show-find-in-preview(): void

• Returns void

workbench.show-quick-open:function

• workbench.show-quick-open(): void

• Returns void

workbench.toggle-outline:function

• workbench.toggle-outline(visible?: boolean): void

• Parameters

  • Optional visible: boolean

  Returns void

xterm.init:function

• xterm.init(opts?: { cwd?: string }): void

• Parameters

  • Optional opts: { cwd?: string }

    • Optional cwd?: string

  Returns void

xterm.run:function

• xterm.run(cmd: string | { code: string; exit?: string; start: string }): void

• Parameters

  • cmd: string | { code: string; exit?: string; start: string }

  Returns void

ACTION_AFTER_RUN: { name: string }

• name: string

ACTION_BEFORE_RUN: { name: string }

• name: string

CODE_RUNNER_CHANGE: { type: "register" | "remove" }

• type: "register" | "remove"

COMMAND_KEYBINDING_CHANGED: never

DEEP_LINK_OPEN: { url: string }

• url: string

DOC_BEFORE_SAVE: { content: string; doc: Doc }

• content: string

• doc: Doc

DOC_BEFORE_SWITCH: { doc?: Doc | null }

• Optional doc?: Doc | null

DOC_CHANGED: { doc: Doc }

• doc: Doc

DOC_CREATED: { doc: Doc }

• doc: Doc

DOC_DELETED: { doc: Doc }

• doc: Doc

DOC_MOVED: { newDoc: Doc; oldDoc: Doc }

• newDoc: Doc

• oldDoc: Doc

DOC_PRE_ENSURE_CURRENT_FILE_SAVED: never

DOC_PRE_SWITCH: { doc?: Doc | null }

• Optional doc?: Doc | null

DOC_SAVED: { doc: Doc }

• doc: Doc

DOC_SWITCHED: { doc: Doc | null }

• doc: Doc | null

DOC_SWITCHING: { doc?: Doc | null }

• Optional doc?: Doc | null

DOC_SWITCH_FAILED: { doc?: Doc | null; message: string }

• Optional doc?: Doc | null

• message: string

EDITOR_CONTENT_CHANGE: { uri: string; value: string }

• uri: string

• value: string

EDITOR_CURRENT_EDITOR_CHANGE: { current?: CustomEditor | null }

• Optional current?: CustomEditor | null

EDITOR_CUSTOM_EDITOR_CHANGE: { type: "register" | "remove" | "switch" }

• type: "register" | "remove" | "switch"

EDITOR_PASTE_IMAGE: { file: File }

• file: File

EDITOR_READY: { editor: Monaco.editor.IStandaloneCodeEditor; monaco: typeof Monaco }

• editor: Monaco.editor.IStandaloneCodeEditor

• monaco: typeof Monaco

EXPORT_AFTER_PREPARE: { type: ExportType }

• type: ExportType

EXPORT_BEFORE_PREPARE: { type: ExportType }

• type: ExportType

EXTENSION_READY: { extensions: Extension[] }

• extensions: Extension[]

GLOBAL_KEYDOWN: KeyboardEvent

GLOBAL_KEYUP: KeyboardEvent

GLOBAL_RESIZE: never

I18N_CHANGE_LANGUAGE: { currentLang: Language; lang: LanguageName }

• currentLang: Language

• lang: LanguageName

MARKDOWN_BEFORE_RENDER: { env: RenderEnv; md: markdownit; src: string }

• env: RenderEnv

• md: markdownit

• src: string

MONACO_BEFORE_INIT: { monaco: typeof Monaco }

• monaco: typeof Monaco

MONACO_READY: { editor: Monaco.editor.IStandaloneCodeEditor; monaco: typeof Monaco }

• editor: Monaco.editor.IStandaloneCodeEditor

• monaco: typeof Monaco

PLUGIN_HOOK: { payload: { latex: string; options: any }; plugin: "markdown-katex"; type: "before-render" }

• payload: { latex: string; options: any }

  • latex: string

  • options: any

• plugin: "markdown-katex"

• type: "before-render"

PREMIUM_STATUS_CHANGED: never

SETTING_BEFORE_WRITE: { settings: Partial<BuildInSettings> }

• settings: Partial<BuildInSettings>

SETTING_CHANGED: { changedKeys: keyof BuildInSettings[]; oldSettings: BuildInSettings; schema: SettingSchema; settings: BuildInSettings }

• changedKeys: keyof BuildInSettings[]

• oldSettings: BuildInSettings

• schema: SettingSchema

• settings: BuildInSettings

SETTING_FETCHED: { oldSettings: BuildInSettings; settings: BuildInSettings }

• oldSettings: BuildInSettings

• settings: BuildInSettings

SETTING_PANEL_BEFORE_SHOW: {}

STARTUP: never

THEME_CHANGE: { name: ThemeName }

• name: ThemeName

TREE_NODE_DBLCLICK: { node: Components.Tree.Node }

• node: Components.Tree.Node

TREE_NODE_SELECT: { node: Components.Tree.Node }

• node: Components.Tree.Node

VIEW_AFTER_REFRESH: never

VIEW_BEFORE_REFRESH: never

VIEW_ELEMENT_CLICK: { e: MouseEvent; view: HTMLElement }

• e: MouseEvent

• view: HTMLElement

VIEW_ELEMENT_DBCLICK: { e: MouseEvent; view: HTMLElement }

• e: MouseEvent

• view: HTMLElement

VIEW_FILE_CHANGE: never

VIEW_KEY_DOWN: { e: KeyboardEvent; view: HTMLElement }

• e: KeyboardEvent

• view: HTMLElement

VIEW_MOUNTED: never

VIEW_ON_GET_HTML_FILTER_NODE: { node: HTMLElement; options: { highlightCode?: boolean; includeStyle?: boolean; inlineLocalImage?: boolean; inlineStyle?: boolean; onlySelected?: boolean; preferPng?: boolean; uploadLocalImage?: boolean; nodeProcessor?: any } }

• node: HTMLElement

• options: { highlightCode?: boolean; includeStyle?: boolean; inlineLocalImage?: boolean; inlineStyle?: boolean; onlySelected?: boolean; preferPng?: boolean; uploadLocalImage?: boolean; nodeProcessor?: any }

  • Optional highlightCode?: boolean

  • Optional includeStyle?: boolean

  • Optional inlineLocalImage?: boolean

  • Optional inlineStyle?: boolean

  • Optional onlySelected?: boolean

  • Optional preferPng?: boolean

  • Optional uploadLocalImage?: boolean

  • nodeProcessor?:function

    • nodeProcessor(node: HTMLElement): void

    • Parameters

      • node: HTMLElement

      Returns void

VIEW_PREVIEWER_CHANGE: { type: "register" | "remove" | "switch" }

• type: "register" | "remove" | "switch"

VIEW_RENDER: never

VIEW_RENDERED: never

VIEW_RENDER_IFRAME_READY: { iframe: HTMLIFrameElement }

• iframe: HTMLIFrameElement

VIEW_SCROLL: { e: Event }

• e: Event

Optional fromHtmlOptions?: { highlightCode: boolean; includeStyle: boolean; inlineLocalImage: boolean; inlineStyle: boolean; uploadLocalImage: boolean }

• highlightCode: boolean

• includeStyle: boolean

• inlineLocalImage: boolean

• inlineStyle: boolean

• uploadLocalImage: boolean

fromType: "markdown" | "html"

toType: "docx" | "html" | "rst" | "adoc"

component: any

displayName: string

Optional hiddenPreview?: boolean

name: string

getIsDirty?:function

• getIsDirty(): boolean | Promise<boolean>

• Returns boolean | Promise<boolean>

when:function

• when(ctx: CustomEditorCtx): boolean | Promise<boolean>

• Parameters

  • ctx: CustomEditorCtx

  Returns boolean | Promise<boolean>

Optional doc?: Doc | null

reason: string

value: boolean

activationTime: number

plugin: boolean

style: boolean

themes: boolean

Optional version?: string

by: "mtime" | "birthtime" | "name" | "serial"

order: "asc" | "desc"

Optional caseSensitive?: boolean

Optional exclude?: string

Optional include?: string

Optional pattern?: string

Optional regExp?: boolean

Optional wholeWord?: boolean

Optional defaultPreviewer?: string

Optional define?: Record<string, boolean>

Optional enableMacro?: boolean

Optional headingNumber?: boolean

Optional mdOptions?: Record<string, boolean>

Optional wrapCode?: boolean

command: string

keys: string | null

type: "workbench" | "editor" | "application"

component: any

Optional displayName?: string

name: string

Optional landscape?: boolean

Optional pageSize?: string

Optional printBackground?: boolean

Optional scaleFactor?: number

Optional attributes?: Record<string, any>

file: Doc | null

renderCount: number

Optional safeMode?: boolean

source: string

tokens: Token[]

groups: { label: TTitle; value: SettingGroup }[]

properties: { [ K in keyof BuildInSettings]: { defaultValue: BuildInSettings[K] extends any ? BuildInSettings[K] : any; description?: TTitle; enum?: string[] | number[]; group: SettingGroup; items?: { properties: { [ K in string]: { description?: TTitle; options: { inputAttributes: { placeholder: TTitle } }; title: TTitle; type: string } }; title: TTitle; type: string }; needReloadWindowWhenChanged?: boolean; required?: boolean; title: TTitle; type: string; validator?: any } }

required: keyof BuildInSettings[]

title: TTitle

type: string