Interface Folding

foldWidgets

getFoldWidget

getFoldWidgetRange

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.

  Parameters

  • placeholder: string | Fold
  • Optionalrange: Range

  Returns Fold

addFolds

• addFolds(folds: Fold[]): void

  Parameters

  • folds: Fold[]

  Returns void

expandFold

• expandFold(fold: Fold): void

  Parameters

  • fold: Fold

  Returns void

expandFolds

• expandFolds(folds: Fold[]): void

  Parameters

  • folds: Fold[]

  Returns void

foldAll

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

  Parameters

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

  Returns void

foldAllComments

• foldAllComments(): void

  Returns void

foldToLevel

• foldToLevel(level: number): void

  Parameters

  • level: number

  Returns void

getAllFolds

• getAllFolds(): Fold[]

  Returns all folds in the document

  Returns Fold[]

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

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

  Parameters

  • docRow: number
  • OptionalstartFoldLine: FoldLine

  Returns FoldLine

getFoldsInRange

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

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

  Parameters

  • range: Range | Ace.Delta

  Returns Fold[]

getFoldsInRangeList

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

  Parameters

  • ranges: Range | Range[]

  Returns 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"

  Parameters

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

  Returns string

getNextFoldLine

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

  Returns the fold which starts after or contains docRow

  Parameters

  • docRow: number
  • OptionalstartFoldLine: FoldLine

  Returns FoldLine

getParentFoldRangeData

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

  Parameters

  • row: number
  • OptionalignoreCurrent: boolean

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

getRowFoldEnd

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

  Parameters

  • docRow: number
  • OptionalstartFoldRow: FoldLine

  Returns number

getRowFoldStart

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

  Parameters

  • docRow: number
  • OptionalstartFoldRow: FoldLine

  Returns 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.

  Parameters

  • docRow: number
  • OptionalstartFoldRow: FoldLine

  Returns boolean

onFoldWidgetClick

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

  Parameters

  • row: number
  • e: any

  Returns void

removeFold

• removeFold(fold: Fold): void

  Parameters

  • fold: Fold

  Returns void

removeFolds

• removeFolds(folds: Fold[]): void

  Parameters

  • folds: Fold[]

  Returns void

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

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

  Parameters

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

  Returns Fold[]

updateFoldWidgets

• updateFoldWidgets(delta: Ace.Delta): void

  Parameters

  • delta: Ace.Delta

  Returns void