Class Folding

Constructors

constructor

Properties

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

Constructors

constructor

Properties

addFold

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

Adds a new fold.

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

addFolds

addFolds: (folds: Fold[]) => void

expandFold

expandFold: (fold: Fold) => void

expandFolds

expandFolds: (folds: Fold[]) => void

foldAll

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

foldAllComments

foldAllComments: () => void

foldToLevel

foldToLevel: (level: number) => void

getAllFolds

getAllFolds: () => Fold[]

Returns all folds in the document

getCommentFoldRange

getCommentFoldRange: (row: number, column: number, dir?: number) => Range

getDisplayLine

getDisplayLine: (
    row: number,
    endColumn: number,
    startRow: number,
    startColumn: number,
) => 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

getFoldDisplayLine

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

getFoldedRowCount

getFoldedRowCount: (first: number, last: number) => number

getFoldLine

getFoldLine: (docRow: number, startFoldLine?: FoldLine) => FoldLine

getFoldsInRange

getFoldsInRange: (range: Delta | Range) => Fold[]

Returns all folds in the given range. Note, that this will return folds

getFoldsInRangeList

getFoldsInRangeList: (ranges: Range | Range[]) => Fold[]

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"

getNextFoldLine

getNextFoldLine: (docRow: number, startFoldLine?: FoldLine) => FoldLine

Returns the fold which starts after or contains docRow

getParentFoldRangeData

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

getRowFoldEnd

getRowFoldEnd: (docRow: number, startFoldRow?: FoldLine) => number

getRowFoldStart

getRowFoldStart: (docRow: number, startFoldRow?: FoldLine) => number

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.

onFoldWidgetClick

onFoldWidgetClick: (row: number, e: any) => void

removeFold

removeFold: (fold: Fold) => void

removeFolds

removeFolds: (folds: Fold[]) => void

setFoldStyle

setFoldStyle: (style: string) => void

toggleFold

toggleFold: (tryToUnfold?: boolean) => void

toggleFoldWidget

toggleFoldWidget: (toggleParent?: boolean) => void

tokenizerUpdateFoldWidgets

tokenizerUpdateFoldWidgets: (e: any) => void

unfold

unfold: (
    location?: number | Point | Range | Range[],
    expandInner?: boolean,
) => Fold[]

updateFoldWidgets

updateFoldWidgets: (delta: Delta) => void

Settings

Member Visibility

On This Page

Constructors
Properties