Class Gutter

constructor

• new Gutter(parentEl): Gutter

• Parameters

  • parentEl: HTMLElement

  Returns Gutter

$annotations

$cursorCell

$cursorRow

$fixedWidth

$highlightGutterLine

$lines

$padding

$renderer

$showFoldWidgets

$showLineNumbers

config

element

gutterWidth

oldLastRow

session

$addCustomWidget

• $addCustomWidget(row, attributes, cell): 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): 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 null if not found

$hideFoldWidget

• $hideFoldWidget(row, cell): 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, cell): 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, config, fold, row): any

• Parameters

  • cell: any

  • config: LayerConfig

  • fold: IRange

  • row: number

  Returns any

$renderLines

• $renderLines(config, firstRow, lastRow): any[]

• Parameters

  • config: LayerConfig

  • firstRow: number

  • lastRow: number

  Returns any[]

$showFoldWidget

• $showFoldWidget(row, cell): 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): void

• Parameters

  • delta: Delta

  Returns void

$updateCursorRow

• $updateCursorRow(): void

• Returns void

$updateGutterWidth

• $updateGutterWidth(config): void

• Parameters

  • config: LayerConfig

  Returns void

addGutterDecoration

• addGutterDecoration(row, className): void

• Parameters

  • row: number

  • className: string

  Returns void

getRegion

• getRegion(point): "markers" | "foldWidgets"

• Parameters

  • point: {
        x: number;
    }

    • x: number

  Returns "markers" | "foldWidgets"

getShowFoldWidgets

• getShowFoldWidgets(): boolean

• Returns boolean

getShowLineNumbers

• getShowLineNumbers(): boolean

• Returns boolean

removeGutterDecoration

• removeGutterDecoration(row, className): void

• Parameters

  • row: number

  • className: string

  Returns void

scrollLines

• scrollLines(config): void

• Parameters

  • config: LayerConfig

  Returns void

setAnnotations

• setAnnotations(annotations): void

• Parameters

  • annotations: any[]

  Returns void

setHighlightGutterLine

• setHighlightGutterLine(highlightGutterLine): void

• Parameters

  • highlightGutterLine: boolean

  Returns void

setSession

• setSession(session): void

• Parameters

  • session: EditSession

  Returns void

setShowFoldWidgets

• setShowFoldWidgets(show?): void

• Parameters

  • Optional show: boolean

  Returns void

setShowLineNumbers

• setShowLineNumbers(show): void

• Parameters

  • show: boolean

  Returns void

update

• update(config): void

• Parameters

  • config: LayerConfig

  Returns void

updateLineHighlight

• updateLineHighlight(): void

• Returns void