Class OutlineViewService

Hierarchy

OutlineViewService

Implements

WidgetFactory

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new OutlineViewService(factory: OutlineViewWidgetFactory): OutlineViewService

- Defined in packages/outline-view/src/browser/outline-view-service.ts:32
Parameters
- factory: OutlineViewWidgetFactory
Returns OutlineViewService

Properties

Protected factory

factory: OutlineViewWidgetFactory

id

id: string = 'outline-view'

Protected Readonly onDidChangeOpenStateEmitter

onDidChangeOpenStateEmitter: Emitter<boolean> = ...

Protected Readonly onDidChangeOutlineEmitter

onDidChangeOutlineEmitter: Emitter<OutlineSymbolInformationNode[]> = ...

Protected Readonly onDidOpenEmitter

onDidOpenEmitter: Emitter<OutlineSymbolInformationNode> = ...

Protected Readonly onDidSelectEmitter

onDidSelectEmitter: Emitter<OutlineSymbolInformationNode> = ...

Protected Optional widget

widget: OutlineViewWidget

Accessors

onDidChangeOpenState

get onDidChangeOpenState(): Event<boolean>

- Defined in packages/outline-view/src/browser/outline-view-service.ts:48
Returns Event<boolean>

onDidChangeOutline

get onDidChangeOutline(): Event<OutlineSymbolInformationNode[]>

- Defined in packages/outline-view/src/browser/outline-view-service.ts:44
Returns Event<OutlineSymbolInformationNode[]>

onDidOpen

get onDidOpen(): Event<OutlineSymbolInformationNode>

- Defined in packages/outline-view/src/browser/outline-view-service.ts:40
Returns Event<OutlineSymbolInformationNode>

onDidSelect

get onDidSelect(): Event<OutlineSymbolInformationNode>

- Defined in packages/outline-view/src/browser/outline-view-service.ts:36
Returns Event<OutlineSymbolInformationNode>

open

get open(): boolean

- Defined in packages/outline-view/src/browser/outline-view-service.ts:52
Returns boolean

Methods

createWidget

createWidget(): Promise<Widget>

Implementation of WidgetFactory.createWidget
- Defined in packages/outline-view/src/browser/outline-view-service.ts:70
Returns Promise<Widget>

publish

publish(roots: OutlineSymbolInformationNode[]): void

- Defined in packages/outline-view/src/browser/outline-view-service.ts:61
Publish the collection of outline view symbols.
- Publishing includes setting the OutlineViewWidget tree with symbol information.
Parameters
- roots: OutlineSymbolInformationNode[]
  
  the list of outline symbol information nodes.
Returns void