Interface Folding

interface Folding {
    addFold(placeholder, range?): Ace.Fold;
    addFolds(folds): void;
    expandFold(fold): void;
    expandFolds(folds): void;
    foldAll(startRow?, endRow?, depth?): void;
    getAllFolds(): Ace.Fold[];
    getCommentFoldRange(row, column, dir): Ace.Range;
    getDisplayLine(row, endColumn, startRow, startColumn): string;
    getFoldAt(row, column, side): Ace.Fold;
    getFoldDisplayLine(foldLine, endRow, endColumn, startRow, startColumn): string;
    getFoldLine(docRow, startFoldLine?): Ace.FoldLine;
    getFoldRowEnd(docRow, startFoldRow?): number;
    getFoldRowStart(docRow, startFoldRow?): number;
    getFoldStringAt(row, column, trim?, foldLine?): string;
    getFoldedRowCount(first, last): number;
    getFoldsInRange(range): Ace.Fold[];
    getFoldsInRangeList(ranges): Ace.Fold[];
    getNextFoldLine(docRow, startFoldLine?): Ace.FoldLine;
    getParentFoldRangeData(row, ignoreCurrent?): {
        firstRange: Ace.Range;
        range?: Ace.Range;
    };
    isRowFolded(docRow, startFoldRow?): boolean;
    removeFold(fold): void;
    removeFolds(folds): void;
    setFoldStyle(style): void;
    toggleFold(tryToUnfold?): void;
    toggleFoldWidget(toggleParent?): void;
    unfold(location, expandInner?): Ace.Fold[];
    updateFoldWidgets(delta): void;
}

Hierarchy (view full)

Folding
- Ace.EditSession

Methods

addFold

addFold(placeholder, range?): Ace.Fold
Parameters
- placeholder: string | Ace.Fold
- Optional range: Ace.Range
Returns Ace.Fold
- Defined in ace.d.ts:94

addFolds

addFolds(folds): void
Parameters
- folds: Ace.Fold[]
Returns void
- Defined in ace.d.ts:95

expandFold

expandFold(fold): void
Parameters
- fold: Ace.Fold
Returns void
- Defined in ace.d.ts:98

expandFolds

expandFolds(folds): void
Parameters
- folds: Ace.Fold[]
Returns void
- Defined in ace.d.ts:99

foldAll

foldAll(startRow?, endRow?, depth?): void
Parameters
- Optional startRow: number
- Optional endRow: number
- Optional depth: number
Returns void
- Defined in ace.d.ts:118

getAllFolds

getAllFolds(): Ace.Fold[]
Returns Ace.Fold[]
- Defined in ace.d.ts:86

getCommentFoldRange

getCommentFoldRange(row, column, dir): Ace.Range
Parameters
- row: number
- column: number
- dir: number
Returns Ace.Range
- Defined in ace.d.ts:115

getDisplayLine

getDisplayLine(row, endColumn, startRow, startColumn): string
Parameters
- row: number
- endColumn: number
- startRow: number
- startColumn: number
Returns string
- Defined in ace.d.ts:110

getFoldAt

getFoldAt(row, column, side): Ace.Fold
Parameters
- row: number
- column: number
- side: number
Returns Ace.Fold
- Defined in ace.d.ts:83

getFoldDisplayLine

getFoldDisplayLine(foldLine, endRow, endColumn, startRow, startColumn): string
Parameters
- foldLine: Ace.FoldLine
- endRow: number
- endColumn: number
- startRow: number
- startColumn: number
Returns string
- Defined in ace.d.ts:105

getFoldLine

getFoldLine(docRow, startFoldLine?): Ace.FoldLine
Parameters
- docRow: number
- Optional startFoldLine: Ace.FoldLine
Returns Ace.FoldLine
- Defined in ace.d.ts:91

getFoldRowEnd

getFoldRowEnd(docRow, startFoldRow?): number
Parameters
- docRow: number
- Optional startFoldRow: Ace.FoldLine
Returns number
- Defined in ace.d.ts:103

getFoldRowStart

getFoldRowStart(docRow, startFoldRow?): number
Parameters
- docRow: number
- Optional startFoldRow: Ace.FoldLine
Returns number
- Defined in ace.d.ts:104

getFoldStringAt

getFoldStringAt(row, column, trim?, foldLine?): string
Parameters
- row: number
- column: number
- Optional trim: number
- Optional foldLine: Ace.FoldLine
Returns string
- Defined in ace.d.ts:87

getFoldedRowCount

getFoldedRowCount(first, last): number
Parameters
- first: number
- last: number
Returns number
- Defined in ace.d.ts:93

getFoldsInRange

getFoldsInRange(range): Ace.Fold[]
Parameters
- range: Ace.Range
Returns Ace.Fold[]
- Defined in ace.d.ts:84

getFoldsInRangeList

getFoldsInRangeList(ranges): Ace.Fold[]
Parameters
- ranges: Ace.Range[]
Returns Ace.Fold[]
- Defined in ace.d.ts:85

getNextFoldLine

getNextFoldLine(docRow, startFoldLine?): Ace.FoldLine
Parameters
- docRow: number
- Optional startFoldLine: Ace.FoldLine
Returns Ace.FoldLine
- Defined in ace.d.ts:92

getParentFoldRangeData

getParentFoldRangeData(row, ignoreCurrent?): {
firstRange: Ace.Range;
range?: Ace.Range;
}
Parameters
- row: number
- Optional ignoreCurrent: boolean
Returns {
firstRange: Ace.Range;
range?: Ace.Range;
}
- firstRange: Ace.Range
- Optional range?: Ace.Range
- Defined in ace.d.ts:120

isRowFolded

isRowFolded(docRow, startFoldRow?): boolean
Parameters
- docRow: number
- Optional startFoldRow: Ace.FoldLine
Returns boolean
- Defined in ace.d.ts:102

removeFold

removeFold(fold): void
Parameters
- fold: Ace.Fold
Returns void
- Defined in ace.d.ts:96

removeFolds

removeFolds(folds): void
Parameters
- folds: Ace.Fold[]
Returns void
- Defined in ace.d.ts:97

setFoldStyle

setFoldStyle(style): void
Parameters
- style: string
Returns void
- Defined in ace.d.ts:119

toggleFold

toggleFold(tryToUnfold?): void
Parameters
- Optional tryToUnfold: boolean
Returns void
- Defined in ace.d.ts:114

toggleFoldWidget

toggleFoldWidget(toggleParent?): void
Parameters
- Optional toggleParent: boolean
Returns void
- Defined in ace.d.ts:124

unfold

unfold(location, expandInner?): Ace.Fold[]
Parameters
- location: number | Ace.Range | Ace.Point
- Optional expandInner: boolean
Returns Ace.Fold[]
- Defined in ace.d.ts:100

updateFoldWidgets

updateFoldWidgets(delta): void
Parameters
- delta: Ace.Delta
Returns void
- Defined in ace.d.ts:125

Interface Folding

Hierarchy (view full)

Index

Methods

Methods

addFold

Parameters

placeholder: string | Ace.Fold

Optional range: Ace.Range

Returns Ace.Fold

addFolds

Parameters

folds: Ace.Fold[]

Returns void

expandFold

Parameters

fold: Ace.Fold

Returns void

expandFolds

Parameters

folds: Ace.Fold[]

Returns void

foldAll

Parameters

Optional startRow: number

Optional endRow: number

Optional depth: number

Returns void

getAllFolds

Returns Ace.Fold[]

getCommentFoldRange

Parameters

row: number

column: number

dir: number

Returns Ace.Range

getDisplayLine

Parameters

row: number

endColumn: number

startRow: number

startColumn: number

Returns string

getFoldAt

Parameters

row: number

column: number

side: number

Returns Ace.Fold

getFoldDisplayLine

Parameters

foldLine: Ace.FoldLine

endRow: number

endColumn: number

startRow: number

startColumn: number

Returns string

getFoldLine

Parameters

docRow: number

Optional startFoldLine: Ace.FoldLine

Returns Ace.FoldLine

getFoldRowEnd

Parameters

docRow: number

Optional startFoldRow: Ace.FoldLine

Returns number

getFoldRowStart

Parameters

docRow: number

Optional startFoldRow: Ace.FoldLine

Returns number

getFoldStringAt

Parameters

row: number

column: number

Optional trim: number

Optional foldLine: Ace.FoldLine

Returns string

getFoldedRowCount

`Optional` range: Ace.Range

`Optional` startRow: number

`Optional` endRow: number

`Optional` depth: number

`Optional` startFoldLine: Ace.FoldLine

`Optional` startFoldRow: Ace.FoldLine

`Optional` startFoldRow: Ace.FoldLine

`Optional` trim: number

`Optional` foldLine: Ace.FoldLine

`Optional` startFoldLine: Ace.FoldLine

`Optional` ignoreCurrent: boolean

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

`Optional` range?: Ace.Range

`Optional` startFoldRow: Ace.FoldLine

`Optional` tryToUnfold: boolean

`Optional` toggleParent: boolean

`Optional` expandInner: boolean