Class Gutter

constructor

• new Gutter(parentEl: HTMLElement): Gutter

  Parameters

  • parentEl: HTMLElement

  Returns Gutter

$annotations

$cursorCell

$cursorRow

$fixedWidth

$highlightElement

$highlightGutterLine

$lines

$padding

$renderer

$showCursorMarker

$showFoldWidgets

$showLineNumbers

config

element

gutterWidth

oldLastRow

session

$addCustomWidget

• $addCustomWidget(
      row: number,
      attributes: {
          callbacks: any;
          className: string;
          label: string;
          title: string;
      },
      cell: any,
  ): void
  Experimental

  Displays a custom widget for a specific row

  Parameters

  • row: number

    The row number where the widget will be displayed
  • attributes: { callbacks: any; className: string; label: string; title: string }

    Configuration attributes for the widget

    • callbacks: any

      Event callback functions for the widget e.g onClick;

    • className: string

      CSS class name for styling the widget

    • label: string

      Text label to display in the widget

    • title: string

      Tooltip text for the widget
  • cell: any

    Gutter cell

  Returns void

$computePadding

• $computePadding(): {}

  Returns {}

$getGutterCell

• $getGutterCell(row: number): HTMLElement
  Experimental

  Retrieves the gutter cell element at the specified cursor row position.

  Parameters

  • row: number

    The row number in the editor where the gutter cell is located starts from 0

  Returns HTMLElement

  The gutter cell element at the specified row, or undefined if not found

$hideFoldWidget

• $hideFoldWidget(row: number, cell: any): void
  Experimental

  Hides the fold widget/icon from a specific row in the gutter

  Parameters

  • row: number

    The row number from which to hide the fold icon
  • cell: any

    Gutter cell

  Returns void

$removeCustomWidget

• $removeCustomWidget(row: number, cell: any): void
  Experimental

  Remove a custom widget for a specific row

  Parameters

  • row: number

    The row number where the widget will be removed
  • cell: any

    Gutter cell

  Returns void

$renderCell

• $renderCell(
      cell: any,
      config: Ace.LayerConfig,
      fold: Ace.IRange,
      row: number,
  ): any

  Parameters

  • cell: any
  • config: Ace.LayerConfig
  • fold: Ace.IRange
  • row: number

  Returns any

$renderLines

• $renderLines(config: Ace.LayerConfig, firstRow: number, lastRow: number): any[]

  Parameters

  • config: Ace.LayerConfig
  • firstRow: number
  • lastRow: number

  Returns any[]

$showFoldWidget

• $showFoldWidget(row: number, cell: any): void
  Experimental

  Shows the fold widget/icon from a specific row in the gutter

  Parameters

  • row: number

    The row number from which to show the fold icon
  • cell: any

    Gutter cell

  Returns void

$updateAnnotations

• $updateAnnotations(delta: Ace.Delta): void

  Parameters

  • delta: Ace.Delta

  Returns void

$updateCursorMarker

• $updateCursorMarker(): void

  Returns void

$updateCursorRow

• $updateCursorRow(): void

  Returns void

$updateGutterWidth

• $updateGutterWidth(config: Ace.LayerConfig): void

  Parameters

  • config: Ace.LayerConfig

  Returns void

addGutterDecoration

• addGutterDecoration(row: number, className: string): void

  Parameters

  • row: number
  • className: string

  Returns void

getRegion

• getRegion(point: { x: number }): "markers" | "foldWidgets"

  Parameters

  • point: { x: number }

  Returns "markers" | "foldWidgets"

getShowFoldWidgets

• getShowFoldWidgets(): boolean

  Returns boolean

getShowLineNumbers

• getShowLineNumbers(): boolean

  Returns boolean

removeGutterDecoration

• removeGutterDecoration(row: number, className: string): void

  Parameters

  • row: number
  • className: string

  Returns void

scrollLines

• scrollLines(config: Ace.LayerConfig): void

  Parameters

  • config: Ace.LayerConfig

  Returns void

setAnnotations

• setAnnotations(annotations: any[]): void

  Parameters

  • annotations: any[]

  Returns void

setHighlightGutterLine

• setHighlightGutterLine(highlightGutterLine: boolean): void

  Parameters

  • highlightGutterLine: boolean

  Returns void

setSession

• setSession(session: EditSession): void

  Parameters

  • session: EditSession

  Returns void

setShowFoldWidgets

• setShowFoldWidgets(show?: boolean): void

  Parameters

  • Optionalshow: boolean

  Returns void

setShowLineNumbers

• setShowLineNumbers(show: boolean): void

  Parameters

  • show: boolean

  Returns void

update

• update(config: Ace.LayerConfig): void

  Parameters

  • config: Ace.LayerConfig

  Returns void

updateLineHighlight

• updateLineHighlight(): void

  Returns void