Interface IEditorDecorationsCollection

A collection of decorations

interface IEditorDecorationsCollection {
    length: number;
    onDidChange: IEvent<IModelDecorationsChangedEvent>;
    append(newDecorations: readonly IModelDeltaDecoration[]): string[];
    clear(): void;
    getRange(index: number): Range;
    getRanges(): Range[];
    has(decoration: IModelDecoration): boolean;
    set(newDecorations: readonly IModelDeltaDecoration[]): string[];
}

Index

Properties

length onDidChange

Methods

append clear getRange getRanges has set

Properties

length

length: number

Get the decorations count.

`Readonly`onDidChange

onDidChange: IEvent<IModelDecorationsChangedEvent>

An event emitted when decorations change in the editor, but the change is not caused by us setting or clearing the collection.

Methods

append

append(newDecorations: readonly IModelDeltaDecoration[]): string[]
Append newDecorations to this collection.
Parameters
- newDecorations: readonly IModelDeltaDecoration[]
Returns string[]
- Defined in src/components/monaco/bin/monaco.d.ts:2905

clear

clear(): void
Remove all previous decorations.

Returns void
- Defined in src/components/monaco/bin/monaco.d.ts:2909

getRange

getRange(index: number): Range
Get the range for a decoration.
Parameters
- index: number
Returns Range
- Defined in src/components/monaco/bin/monaco.d.ts:2889

getRanges

getRanges(): Range[]
Get all ranges for decorations.

Returns Range[]
- Defined in src/components/monaco/bin/monaco.d.ts:2893

has

has(decoration: IModelDecoration): boolean
Determine if a decoration is in this collection.
Parameters
- decoration: IModelDecoration
Returns boolean
- Defined in src/components/monaco/bin/monaco.d.ts:2897

set

set(newDecorations: readonly IModelDeltaDecoration[]): string[]
Replace all previous decorations with newDecorations.
Parameters
- newDecorations: readonly IModelDeltaDecoration[]
Returns string[]
- Defined in src/components/monaco/bin/monaco.d.ts:2901