Class MonacoEditorPeekViewWidget

Index

Constructors

Properties

Accessors

Methods

addAction clearActions create dispose doLayoutBody doLayoutHead doRevealRange fillBody fillContainer fillHead hide onWidth setCssClass setTitle show style

Constructors

constructor

new MonacoEditorPeekViewWidget(
    editor: MonacoEditor,
    options?: MonacoEditorPeekViewWidget.Options,
    styles?: MonacoEditorPeekViewWidget.Styles,
): MonacoEditorPeekViewWidget
Parameters
- editor: MonacoEditor
- options: MonacoEditorPeekViewWidget.Options = {}
- styles: MonacoEditorPeekViewWidget.Styles = {}
Returns MonacoEditorPeekViewWidget
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:81

Properties

`Readonly`editor

editor: MonacoEditor

`Readonly`onDidClose

onDidClose: Event<void> = ...

`Protected`styles

styles: MonacoEditorPeekViewWidget.Styles = {}

`Protected` `Readonly`toDispose

toDispose: DisposableCollection = ...

Accessors

`Protected`bodyElement

get bodyElement(): undefined | HTMLDivElement
Returns undefined | HTMLDivElement
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:244
set bodyElement(element: undefined | HTMLDivElement): void
Parameters
- element: undefined | HTMLDivElement
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:248

`Protected`headElement

get headElement(): undefined | HTMLDivElement
Returns undefined | HTMLDivElement
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:252
set headElement(element: undefined | HTMLDivElement): void
Parameters
- element: undefined | HTMLDivElement
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:256

Methods

addAction

addAction(
    id: string,
    label: string,
    cssClass: undefined | string,
    enabled: boolean,
    actionCallback: (arg: unknown) => unknown,
    options?: ActionOptions,
): MonacoEditorPeekViewWidget.Action
Parameters
- id: string
- label: string
- cssClass: undefined | string
- enabled: boolean
- actionCallback: (arg: unknown) => unknown
- Optionaloptions: ActionOptions
Returns MonacoEditorPeekViewWidget.Action
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:204

`Protected`doLayoutBody

doLayoutBody(heightInPixel: number, widthInPixel: number): void
Parameters
- heightInPixel: number
- widthInPixel: number
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:232

`Protected`doLayoutHead

doLayoutHead(heightInPixel: number, widthInPixel: number): void
Parameters
- heightInPixel: number
- widthInPixel: number
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:228

`Protected`doRevealRange

doRevealRange(range: Range, isLastLine: boolean): void
Parameters
- range: Range
- isLastLine: boolean
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:240

`Protected`fillBody

fillBody(container: HTMLElement): void
Parameters
- container: HTMLElement
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:224

`Protected`fillContainer

fillContainer(container: HTMLElement): void
Parameters
- container: HTMLElement
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:216

`Protected`fillHead

fillHead(container: HTMLElement, noCloseAction?: boolean): void
Parameters
- container: HTMLElement
- OptionalnoCloseAction: boolean
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:220

hide

hide(): void
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:196

`Protected`onWidth

onWidth(widthInPixel: number): void
Parameters
- widthInPixel: number
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:236

`Protected`setCssClass

setCssClass(className: string, classToReplace?: string): void
Parameters
- className: string
- OptionalclassToReplace: string
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:260

setTitle

setTitle(primaryHeading: string, secondaryHeading?: string): void
Parameters
- primaryHeading: string
- OptionalsecondaryHeading: string
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:184

show

show(rangeOrPos: Position | Range, heightInLines: number): void
Parameters
- rangeOrPos: Position | Range
- heightInLines: number
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:192

style

style(styles: MonacoEditorPeekViewWidget.Styles): void
Parameters
- styles: MonacoEditorPeekViewWidget.Styles
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-peek-view-widget.ts:188

Class MonacoEditorPeekViewWidget

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MonacoEditorPeekViewWidget

Properties

Readonlyeditor

ReadonlyonDidClose

Protectedstyles

Protected ReadonlytoDispose

Accessors

ProtectedbodyElement

Returns undefined | HTMLDivElement

Parameters

Returns void

ProtectedheadElement

Returns undefined | HTMLDivElement

Parameters

Returns void

Methods

addAction

Parameters

Returns MonacoEditorPeekViewWidget.Action

clearActions

Returns void

create

Returns void

dispose

Returns void

ProtecteddoLayoutBody

Parameters

Returns void

ProtecteddoLayoutHead

Parameters

Returns void

ProtecteddoRevealRange

Parameters

Returns void

ProtectedfillBody

Parameters

Returns void

ProtectedfillContainer

Parameters

Returns void

ProtectedfillHead

Parameters

Returns void

hide

Returns void

ProtectedonWidth

Parameters

Returns void

ProtectedsetCssClass

Parameters

Returns void

setTitle

Parameters

Returns void

show

Parameters

Returns void

style

Parameters

Returns void

Settings

On This Page

`Readonly`editor

`Readonly`onDidClose

`Protected`styles

`Protected` `Readonly`toDispose

`Protected`bodyElement

`Protected`headElement

`Protected`doLayoutBody

`Protected`doLayoutHead

`Protected`doRevealRange

`Protected`fillBody

`Protected`fillContainer

`Protected`fillHead

`Protected`onWidth

`Protected`setCssClass