Ace API Reference
    Preparing search index...

    Class Folding

    Index

    Constructors

    constructor

    Properties

    $addFoldLine $cloneFoldData $foldStyle $foldStyles $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

    Constructors

    Properties

    $addFoldLine: (foldLine: FoldLine) => FoldLine

    Type declaration

    $cloneFoldData: () => FoldLine[]

    Type declaration

    $foldStyle: string
    $foldStyles: {}
    $setFolding: (foldMode: FoldMode) => void
    $toggleFoldWidget: (row: number, options: any) => any

    Type declaration

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

      • Parameters

        • row: number
        • options: any

        Returns any

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

    Adds a new fold.

    Type declaration

      • (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.

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

    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[]

    Returns all folds in the document

    Type declaration

      • (): Fold[]

      • Returns all folds in the document

        Returns Fold[]

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

    Type declaration

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

      • Parameters

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

        Returns Range

    getDisplayLine: (
        row: number,
        endColumn: number,
        startRow: number,
        startColumn: number,
    ) => string

    Type declaration

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

      • Parameters

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

        Returns string

    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

    Type declaration

      • (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: (
        foldLine: FoldLine,
        endRow?: number,
        endColumn?: number,
        startRow?: number,
        startColumn?: number,
    ) => string

    Type declaration

      • (
            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: (first: number, last: number) => number

    Type declaration

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

      • Parameters

        • first: number
        • last: number

        Returns number

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

    Type declaration

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

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

    Type declaration

      • (range: Ace.Delta | Range): Fold[]

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

        Parameters

        Returns Fold[]

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

    Type declaration

      • (ranges: Range | Range[]): Fold[]

      • Parameters

        • ranges: Range | Range[]

        Returns Fold[]

    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"

    Type declaration

      • (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: (docRow: number, startFoldLine?: FoldLine) => FoldLine

    Returns the fold which starts after or contains docRow

    Type declaration

      • (docRow: number, startFoldLine?: FoldLine): FoldLine

      • Returns the fold which starts after or contains docRow

        Parameters

        • docRow: number
        • OptionalstartFoldLine: FoldLine

        Returns FoldLine

    getParentFoldRangeData: (row: number, ignoreCurrent?: boolean) => {}

    Type declaration

      • (row: number, ignoreCurrent?: boolean): {}

      • Parameters

        • row: number
        • OptionalignoreCurrent: boolean

        Returns {}

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

    Type declaration

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

      • Parameters

        • docRow: number
        • OptionalstartFoldRow: FoldLine

        Returns number

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

    Type declaration

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

      • Parameters

        • docRow: number
        • OptionalstartFoldRow: FoldLine

        Returns number

    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.

    Type declaration

      • (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: (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 | Ace.Point | Range | Range[],
        expandInner?: boolean,
    ) => Fold[]

    Type declaration

      • (location?: number | Ace.Point | Range | Range[], expandInner?: boolean): Fold[]

      • Parameters

        • Optionallocation: number | Ace.Point | Range | Range[]
        • OptionalexpandInner: boolean

        Returns Fold[]

    updateFoldWidgets: (delta: Ace.Delta) => void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties