Class MarkdownPreviewHandler

constructor

• new MarkdownPreviewHandler(): MarkdownPreviewHandler

  Returns MarkdownPreviewHandler

ReadonlycontentClass

ReadonlyiconClass

canHandle

• canHandle(uri: URI): number

  Indicates whether and with which priority (larger is better) this preview handler is responsible for the resource identified by the given URI. If multiple handlers return the same priority it's undefined which one will be used.

  Parameters

  • uri: URI

    the URI identifying a resource.

  Returns number

  a number larger than 0 if the handler is applicable, 0 or a negative number otherwise.

findElementForFragment

• findElementForFragment(
      content: HTMLElement,
      link: string,
  ): undefined | HTMLElement

  Search and return the HTMLElement which corresponds to the given fragment. This is used to initially reveal elements identified via the URI fragment.

  Parameters

  • content: HTMLElement

    the preview widget element containing the content previously rendered by PreviewHandler.renderContent.

  • link: string

    the URI fragment for which the corresponding element shall be returned

  Returns undefined | HTMLElement

  the HTMLElement which is part of content and corresponds to the given fragment, undefined otherwise.

findElementForSourceLine

• findElementForSourceLine(
      content: HTMLElement,
      sourceLine: number,
  ): undefined | HTMLElement

  Search and return the HTMLElement which corresponds to the given line number. This is used to scroll the preview when the source editor scrolls.

  Parameters

  • content: HTMLElement

    the preview widget element containing the previously rendered by PreviewHandler.renderContent.

  • sourceLine: number

    the line number for which the corresponding element shall be returned.

  Returns undefined | HTMLElement

  the HTMLElement which is part of content and corresponds to the given line number, undefined otherwise.

getSourceLineForOffset

• getSourceLineForOffset(content: HTMLElement, offset: number): undefined | number

  Returns the line number which corresponds to the preview element at the given offset. This is used to scroll the source editor when the preview scrolls.

  Parameters

  • content: HTMLElement

    the preview widget element containing the previously rendered by PreviewHandler.renderContent.

  • offset: number

    the total amount by which the preview widget is scrolled.

  Returns undefined | number

  the source line number which corresponds to the preview element at the given offset, undefined otherwise.

renderContent

• renderContent(params: RenderContentParams): HTMLElement

  Render the preview content by returning appropriate HTML.

  Parameters

  • params: RenderContentParams

    information for the handler to render its content.

  Returns HTMLElement

  the HTMLElement which will be attached to the preview widget.