Interface Folding

interface Folding {
    $foldData: FoldLine[];
    $foldMode: any;
    $foldStyle: string;
    $foldStyles: { manual: number; markbegin: number; markbeginend: number };
    $modified: boolean;
    $tokenizerUpdateFoldWidgets: any;
    $updateFoldWidgets: any;
    foldWidgets: any[];
    getFoldWidget: any;
    getFoldWidgetRange: any;
    $addFoldLine(foldLine: FoldLine): FoldLine;
    $cloneFoldData(): FoldLine[];
    $setFolding(foldMode: FoldMode): void;
    $toggleFoldWidget(row: number, options: any): any;
    addFold(placeholder: string | Fold, range?: Range): Fold;
    addFolds(folds: Fold[]): void;
    expandFold(fold: Fold): void;
    expandFolds(folds: Fold[]): void;
    foldAll(
        startRow?: number,
        endRow?: number,
        depth?: number,
        test?: Function,
    ): void;
    foldAllComments(): void;
    foldToLevel(level: number): void;
    getAllFolds(): Fold[];
    getCommentFoldRange(row: number, column: number, dir?: number): Range;
    getDisplayLine(
        row: number,
        endColumn: number,
        startRow: number,
        startColumn: number,
    ): string;
    getFoldAt(row: number, column: number, side?: number): Fold;
    getFoldDisplayLine(
        foldLine: FoldLine,
        endRow?: number,
        endColumn?: number,
        startRow?: number,
        startColumn?: number,
    ): string;
    getFoldedRowCount(first: number, last: number): number;
    getFoldLine(docRow: number, startFoldLine?: FoldLine): FoldLine;
    getFoldsInRange(range: Delta | Range): Fold[];
    getFoldsInRangeList(ranges: Range | Range[]): Fold[];
    getFoldStringAt(
        row: number,
        column: number,
        trim?: number,
        foldLine?: FoldLine,
    ): string;
    getNextFoldLine(docRow: number, startFoldLine?: FoldLine): FoldLine;
    getParentFoldRangeData(
        row: number,
        ignoreCurrent?: boolean,
    ): { firstRange?: Range; range?: Range };
    getRowFoldEnd(docRow: number, startFoldRow?: FoldLine): number;
    getRowFoldStart(docRow: number, startFoldRow?: FoldLine): number;
    isRowFolded(docRow: number, startFoldRow?: FoldLine): boolean;
    onFoldWidgetClick(row: number, e: any): void;
    removeFold(fold: Fold): void;
    removeFolds(folds: Fold[]): void;
    setFoldStyle(style: string): void;
    toggleFold(tryToUnfold?: boolean): void;
    toggleFoldWidget(toggleParent?: boolean): void;
    tokenizerUpdateFoldWidgets(e: any): void;
    unfold(
        location?: number | Point | Range | Range[],
        expandInner?: boolean,
    ): Fold[];
    updateFoldWidgets(delta: Delta): void;
}

Hierarchy (View Summary)

Properties

$foldData $foldMode $foldStyle $foldStyles $modified $tokenizerUpdateFoldWidgets $updateFoldWidgets foldWidgets getFoldWidget getFoldWidgetRange

Methods

$addFoldLine $cloneFoldData $setFolding $toggleFoldWidget addFold addFolds expandFold expandFolds foldAll foldAllComments foldToLevel getAllFolds getCommentFoldRange getDisplayLine getFoldAt getFoldDisplayLine getFoldedRowCount getFoldLine getFoldsInRange getFoldsInRangeList getFoldStringAt getNextFoldLine getParentFoldRangeData getRowFoldEnd getRowFoldStart isRowFolded onFoldWidgetClick removeFold removeFolds setFoldStyle toggleFold toggleFoldWidget tokenizerUpdateFoldWidgets unfold updateFoldWidgets

Properties

$foldData

$foldData: FoldLine[]

$foldMode

$foldMode: any

$foldStyle

$foldStyle: string

$foldStyles

$foldStyles: { manual: number; markbegin: number; markbeginend: number }

$modified

$modified: boolean

$tokenizerUpdateFoldWidgets

$tokenizerUpdateFoldWidgets: any

$updateFoldWidgets

$updateFoldWidgets: any

foldWidgets

foldWidgets: any[]

getFoldWidget

getFoldWidget: any

getFoldWidgetRange

getFoldWidgetRange: any

Methods

$addFoldLine

$cloneFoldData

$setFolding

$toggleFoldWidget

  • $toggleFoldWidget(row: number, options: any): any

  • Parameters

    • row: number
    • options: any

    Returns any

addFold

  • addFold(placeholder: string | Fold, range?: Range): Fold

  • Adds a new fold.

    Parameters

    • placeholder: string | Fold
    • Optionalrange: Range

    Returns Fold

    The new created Fold object or an existing fold object in case the passed in range fits an existing fold exactly.

addFolds

expandFold

expandFolds

foldAll

  • foldAll(
        startRow?: number,
        endRow?: number,
        depth?: number,
        test?: Function,
    ): void

  • Parameters

    • OptionalstartRow: number
    • OptionalendRow: number
    • Optionaldepth: number
    • Optionaltest: Function

    Returns void

foldAllComments

foldToLevel

  • foldToLevel(level: number): void

  • Parameters

    • level: number

    Returns void

getAllFolds

getCommentFoldRange

  • getCommentFoldRange(row: number, column: number, dir?: number): Range

  • Parameters

    • row: number
    • column: number
    • Optionaldir: number

    Returns Range

getDisplayLine

  • getDisplayLine(
        row: number,
        endColumn: number,
        startRow: number,
        startColumn: number,
    ): string

  • Parameters

    • row: number
    • endColumn: number
    • startRow: number
    • startColumn: number

    Returns string

getFoldAt

  • getFoldAt(row: number, column: number, side?: number): Fold

  • Looks up a fold at a given row/column. Possible values for side: -1: ignore a fold if fold.start = row/column +1: ignore a fold if fold.end = row/column

    Parameters

    • row: number
    • column: number
    • Optionalside: number

    Returns Fold

getFoldDisplayLine

  • getFoldDisplayLine(
        foldLine: FoldLine,
        endRow?: number,
        endColumn?: number,
        startRow?: number,
        startColumn?: number,
    ): string

  • Parameters

    • foldLine: FoldLine
    • OptionalendRow: number
    • OptionalendColumn: number
    • OptionalstartRow: number
    • OptionalstartColumn: number

    Returns string

getFoldedRowCount

  • getFoldedRowCount(first: number, last: number): number

  • Parameters

    • first: number
    • last: number

    Returns number

getFoldLine

getFoldsInRange

getFoldsInRangeList

getFoldStringAt

  • getFoldStringAt(
        row: number,
        column: number,
        trim?: number,
        foldLine?: FoldLine,
    ): string

  • Returns the string between folds at the given position. E.g. foob|arwolrd -> "bar" foobarwol|rd -> "world" foobar<fo|ld>wolrd ->

    where | means the position of row/column

    The trim option determs if the return string should be trimed according to the "side" passed with the trim value:

    E.g. foob|arwolrd -trim=-1> "b" foobarwol|rd -trim=+1> "rld" fo|obarwolrd -trim=00> "foo"

    Parameters

    • row: number
    • column: number
    • Optionaltrim: number
    • OptionalfoldLine: FoldLine

    Returns string

getNextFoldLine

getParentFoldRangeData

  • getParentFoldRangeData(
        row: number,
        ignoreCurrent?: boolean,
    ): { firstRange?: Range; range?: Range }

  • Parameters

    • row: number
    • OptionalignoreCurrent: boolean

    Returns { firstRange?: Range; range?: Range }

getRowFoldEnd

getRowFoldStart

isRowFolded

  • isRowFolded(docRow: number, startFoldRow?: FoldLine): boolean

  • Checks if a given documentRow is folded. This is true if there are some folded parts such that some parts of the line is still visible.

    Parameters

    • docRow: number
    • OptionalstartFoldRow: FoldLine

    Returns boolean

onFoldWidgetClick

  • onFoldWidgetClick(row: number, e: any): void

  • Parameters

    • row: number
    • e: any

    Returns void

removeFold

removeFolds

setFoldStyle

  • setFoldStyle(style: string): void

  • Parameters

    • style: string

    Returns void

toggleFold

  • toggleFold(tryToUnfold?: boolean): void

  • Parameters

    • OptionaltryToUnfold: boolean

    Returns void

toggleFoldWidget

  • toggleFoldWidget(toggleParent?: boolean): void

  • Parameters

    • OptionaltoggleParent: boolean

    Returns void

tokenizerUpdateFoldWidgets

  • tokenizerUpdateFoldWidgets(e: any): void

  • Parameters

    • e: any

    Returns void

unfold

updateFoldWidgets

Settings

Member Visibility

On This Page

Properties
Methods