Interface IEditorDecorationsCollection

A collection of decorations

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

Properties

length onDidChange

Methods

append clear getRange getRanges has set

Properties

length

length: number

Get the decorations count.

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): string[]

  • Append newDecorations to this collection.

    Parameters

    Returns string[]

clear

  • clear(): void

  • Remove all previous decorations.

    Returns void

getRange

  • getRange(index): Range

  • Get the range for a decoration.

    Parameters

    • index: number

    Returns Range

getRanges

  • getRanges(): Range[]

  • Get all ranges for decorations.

    Returns Range[]

has

  • has(decoration): boolean

  • Determine if a decoration is in this collection.

    Parameters

    Returns boolean

set

  • set(newDecorations): string[]

  • Replace all previous decorations with newDecorations.

    Parameters

    Returns string[]

Settings

Member Visibility

Theme

On This Page

lengthonDidChangeappendcleargetRangegetRangeshasset