Module renderer/services/view

Type aliases

BuildContextMenu

BuildContextMenu: (items: MenuItem[], e: MouseEvent) => void

Type declaration

- (items: MenuItem[], e: MouseEvent): void
- Parameters
  - items: MenuItem[]
  - e: MouseEvent
  Returns void

Heading

Heading: { activated?: boolean; class: string; level: number; sourceLine: number; tag: string; text: string }

Type declaration

Optional activated?: boolean
class: string
level: number
sourceLine: number
tag: string
text: string

MenuItem

MenuItem: Components.ContextMenu.Item

Functions

addScript

addScript(src: string): Promise<HTMLScriptElement>

- Defined in src/renderer/services/view.ts:442
Add script to default preview.

Parameters
- src: string
Returns Promise<HTMLScriptElement>
script dom

addStyleLink

addStyleLink(href: string): Promise<HTMLLinkElement>

- Defined in src/renderer/services/view.ts:425
Add style link to default preview.

Parameters
- href: string
Returns Promise<HTMLLinkElement>
link dom

addStyles

addStyles(style: string): Promise<HTMLStyleElement>

- Defined in src/renderer/services/view.ts:409
Add styles to default preview.

Parameters
- style: string
Returns Promise<HTMLStyleElement>
css dom

disableSyncScrollAwhile

disableSyncScrollAwhile(fn: Function, timeout?: number): Promise<void>

- Defined in src/renderer/services/view.ts:378
disable sync scroll for a while

Parameters
- fn: Function
- timeout: number = 500
Returns Promise<void>

enterPresent

enterPresent(): void

- Defined in src/renderer/services/view.ts:269
Enter presentation mode.

Returns void

exitPresent

exitPresent(): void

- Defined in src/renderer/services/view.ts:276
Exit presentation mode.

Returns void

getAllPreviewers

getAllPreviewers(): Previewer[]

- Defined in src/renderer/services/view.ts:344
Get all previewers.

Returns Previewer[]
Previewers

getContentHtml

getContentHtml(options?: { highlightCode?: boolean; includeStyle?: boolean; inlineLocalImage?: boolean; inlineStyle?: boolean; onlySelected?: boolean; preferPng?: boolean; uploadLocalImage?: boolean; nodeProcessor?: any }): Promise<string>

- Defined in src/renderer/services/view.ts:138
Get rendered HTML.

Parameters
- 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
    - Defined in src/renderer/types.ts:446
      Parameters
      - node: HTMLElement
      Returns void
Returns Promise<string>
HTML

getContextMenuItems

getContextMenuItems(e: MouseEvent): Components.ContextMenu.Item[]

- Defined in src/renderer/services/view.ts:353
Get context menus

Parameters
- e: MouseEvent
Returns Components.ContextMenu.Item[]

getEnableSyncScroll

getEnableSyncScroll(): undefined | null | boolean

- Defined in src/renderer/services/view.ts:367
get enableSyncScroll

Returns undefined | null | boolean

getHeadings

getHeadings(withActivated?: boolean): Heading[]

- Defined in src/renderer/services/view.ts:201
Get Headings

Parameters
- withActivated: boolean = false
Returns Heading[]

getPreviewStyles

getPreviewStyles(): string

- Defined in src/renderer/services/view.ts:106
Returns string

getRenderEnv

getRenderEnv(): null | RenderEnv

- Defined in src/renderer/services/view.ts:262
Get render env.

Returns null | RenderEnv

getRenderIframe

getRenderIframe(): Promise<HTMLIFrameElement>

- Defined in src/renderer/services/view.ts:391
Get render Iframe

Returns Promise<HTMLIFrameElement>

getViewDom

getViewDom(): null | HTMLElement

- Defined in src/renderer/services/view.ts:194
Get view dom.

Returns null | HTMLElement

highlightLine

highlightLine(line: number, reveal: boolean, duration?: number): Promise<void>

- Defined in src/renderer/services/view.ts:77
Highlight line.

@param
reveal

Parameters
- line: number
- reveal: boolean
- duration: number = 1000
Returns Promise<void>

refresh

refresh(): Promise<void>

- Defined in src/renderer/services/view.ts:59
Refresh view.

Returns Promise<void>

registerPreviewer

registerPreviewer(previewer: Previewer): void

- Defined in src/renderer/services/view.ts:325
Register a previewer.

Parameters
- previewer: Previewer
  
  Previewer
Returns void

removePreviewer

removePreviewer(name: string): void

- Defined in src/renderer/services/view.ts:334
Remove a previewer.

Parameters
- name: string
  
  Previewer name
Returns void

render

render(): void

- Defined in src/renderer/services/view.ts:45
Rerender view.

Returns void

renderImmediately

renderImmediately(): void

- Defined in src/renderer/services/view.ts:52
Render Markdown immediately.

Returns void

revealLine

revealLine(startLine: number): Promise<null | HTMLElement>

- Defined in src/renderer/services/view.ts:67
Reveal line.

Parameters
- startLine: number
Returns Promise<null | HTMLElement>

scrollTopTo

scrollTopTo(top: number): Promise<void>

- Defined in src/renderer/services/view.ts:101
Scroll to a position.

Parameters
- top: number
Returns Promise<void>

switchPreviewer

switchPreviewer(name: string): void

- Defined in src/renderer/services/view.ts:308
Switch current previewer

Parameters
- name: string
  
  Previewer name
Returns void

tapContextMenus

tapContextMenus(fun: BuildContextMenu): void

- Defined in src/renderer/services/view.ts:300
Add a context menu processor.

Parameters
- fun: BuildContextMenu
Returns void

toggleAutoPreview

toggleAutoPreview(flag?: boolean): void

- Defined in src/renderer/services/view.ts:284
Toggle auto render preview.

Parameters
- Optional flag: boolean
Returns void

toggleSyncScroll

toggleSyncScroll(flag?: boolean): void

- Defined in src/renderer/services/view.ts:292
Toggle sync scroll.

Parameters
- Optional flag: boolean
Returns void

Generated using TypeDoc