Class OutputChannel

Implements

Disposable

Constructors

constructor

new OutputChannel(
resource: OutputResource,
preferences: OutputPreferences,
): OutputChannel
Parameters
- resource: OutputResource
- preferences: OutputPreferences
Returns OutputChannel
- Defined in packages/output/src/browser/output-channel.ts:223

Properties

`Protected`_maxLineNumber

_maxLineNumber: number

`Protected`ansiState

ansiState: AnsiState = {}

`Protected` `Readonly`contentChangeEmitter

contentChangeEmitter: Emitter<void> = ...

`Protected`decorationIds

decorationIds: Set<string> = ...

`Protected`disposed

disposed: boolean = false

`Protected` `Readonly`disposedEmitter

disposedEmitter: Emitter<void> = ...

`Readonly`onContentChange

onContentChange: Event<void> = ...

`Readonly`onDisposed

onDisposed: Event<void> = ...

`Readonly`onVisibilityChange

onVisibilityChange: Event<{ isVisible: boolean; preserveFocus?: boolean }> = ...

`Protected` `Readonly`preferences

preferences: OutputPreferences

`Protected` `Readonly`resource

resource: OutputResource

`Protected` `Readonly`textModifyQueue

textModifyQueue: PQueue<PriorityQueue, QueueAddOptions> = ...

`Protected` `Readonly`toDispose

toDispose: DisposableCollection = ...

`Protected` `Readonly`visibilityChangeEmitter

visibilityChangeEmitter: Emitter<
{ isVisible: boolean; preserveFocus?: boolean },
> = ...

`Protected`visible

visible: boolean = true

Accessors

isVisible

get isVisible(): boolean
Note: if false it does not meant it is disposed or not available, it is only hidden from the UI.

Returns boolean
- Defined in packages/output/src/browser/output-channel.ts:263

`Protected`maxLineNumber

get maxLineNumber(): number
Returns number
- Defined in packages/output/src/browser/output-channel.ts:414
set maxLineNumber(maxLineNumber: number): void
Parameters
- maxLineNumber: number
Returns void
- Defined in packages/output/src/browser/output-channel.ts:418

name

get name(): string
Returns string
- Defined in packages/output/src/browser/output-channel.ts:237

uri

get uri(): URI
Returns URI
- Defined in packages/output/src/browser/output-channel.ts:241

Methods

append

append(content: string, severity?: OutputChannelSeverity): void
Parameters
- content: string
- severity: OutputChannelSeverity = OutputChannelSeverity.Info
Returns void
- Defined in packages/output/src/browser/output-channel.ts:287

appendLine

appendLine(content: string, severity?: OutputChannelSeverity): void
Parameters
- content: string
- severity: OutputChannelSeverity = OutputChannelSeverity.Info
Returns void
- Defined in packages/output/src/browser/output-channel.ts:291

clear

clear(): void
Returns void
- Defined in packages/output/src/browser/output-channel.ts:267

`Protected`computeSegmentRange

computeSegmentRange(
    strippedText: string,
    segment: AnsiSegment,
    insertPosition: Position,
): Range
Compute the Monaco Range for an ANSI segment within the stripped text, given the insertion position in the editor model.
Parameters
- strippedText: string
- segment: AnsiSegment
- insertPosition: Position
Returns Range
- Defined in packages/output/src/browser/output-channel.ts:355

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of Disposable.dispose
- Defined in packages/output/src/browser/output-channel.ts:278

`Protected`doAppend

doAppend(
    __namedParameters: {
        appendEol?: boolean;
        content: string;
        severity: OutputChannelSeverity;
    },
): Promise<void>
Parameters
- __namedParameters: { appendEol?: boolean; content: string; severity: OutputChannelSeverity }
Returns Promise<void>
- Defined in packages/output/src/browser/output-channel.ts:295

`Protected`ensureMaxChannelHistory

ensureMaxChannelHistory(textModel: ITextModel): void
Parameters
- textModel: ITextModel
Returns void
- Defined in packages/output/src/browser/output-channel.ts:385

hide

hide(): void
Returns void
- Defined in packages/output/src/browser/output-channel.ts:245

show

show(__namedParameters?: { preserveFocus: boolean }): void
If preserveFocus is true, the channel will not take focus. It is false by default.
- Calling show without args or with preserveFocus: false will reveal and activate the Output widget.
- Calling show with preserveFocus: true will reveal the Output widget but won't activate it.
Parameters
- __namedParameters: { preserveFocus: boolean } = ...
Returns void
- Defined in packages/output/src/browser/output-channel.ts:255

Class OutputChannel

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OutputChannel

Properties

Protected_maxLineNumber

ProtectedansiState

Protected ReadonlycontentChangeEmitter

ProtecteddecorationIds

Protecteddisposed

Protected ReadonlydisposedEmitter

ReadonlyonContentChange

ReadonlyonDisposed

ReadonlyonVisibilityChange

Protected Readonlypreferences

Protected Readonlyresource

Protected ReadonlytextModifyQueue

Protected ReadonlytoDispose

Protected ReadonlyvisibilityChangeEmitter

Protectedvisible

Accessors

isVisible

Returns boolean

ProtectedmaxLineNumber

Returns number

Parameters

Returns void

name

Returns string

uri

Returns URI

Methods

append

Parameters

Returns void

appendLine

Parameters

Returns void

clear

Returns void

ProtectedcomputeSegmentRange

Parameters

Returns Range

dispose

Returns void

ProtecteddoAppend

Parameters

Returns Promise<void>

ProtectedensureMaxChannelHistory

Parameters

Returns void

hide

Returns void

show

Parameters

Returns void

Settings

On This Page

`Protected`_maxLineNumber

`Protected`ansiState

`Protected` `Readonly`contentChangeEmitter

`Protected`decorationIds

`Protected`disposed

`Protected` `Readonly`disposedEmitter

`Readonly`onContentChange

`Readonly`onDisposed

`Readonly`onVisibilityChange

`Protected` `Readonly`preferences

`Protected` `Readonly`resource

`Protected` `Readonly`textModifyQueue

`Protected` `Readonly`toDispose

`Protected` `Readonly`visibilityChangeEmitter

`Protected`visible

`Protected`maxLineNumber

`Protected`computeSegmentRange

`Protected`doAppend

`Protected`ensureMaxChannelHistory