Class MonacoOutlineContribution

ProtectedcanUpdateOutline

Protected ReadonlyeditorManager

Protected ReadonlyoutlineViewService

Protectedroots

Protected ReadonlytoDisposeOnEditor

ProtectedtokenSource

ProtectedapplySelection

• applySelection(
      roots: MonacoOutlineSymbolInformationNode[],
      editorSelection?: Range,
  ): boolean

  Sets the selection on the sub-trees based on the optional editor selection. Select the narrowest node that is strictly contains the editor selection.

  Parameters

  • roots: MonacoOutlineSymbolInformationNode[]
  • OptionaleditorSelection: Range

  Returns boolean

ProtectedasRange

• asRange(range: IRange): Range

  monaco to LSP Range converter. Converts the 1-based location indices into 0-based ones.

  Parameters

  • range: IRange

  Returns Range

ProtectedcreateId

• createId(name: string, ids: Map<string, number>): string

  Parameters

  • name: string
  • ids: Map<string, number>

  Returns string

ProtectedcreateNode

• createNode(
      uri: URI,
      symbol: DocumentSymbol,
      ids: Map<string, number>,
      parent?: MonacoOutlineSymbolInformationNode,
  ): MonacoOutlineSymbolInformationNode

  Parameters

  • uri: URI
  • symbol: DocumentSymbol
  • ids: Map<string, number>
  • Optionalparent: MonacoOutlineSymbolInformationNode

  Returns MonacoOutlineSymbolInformationNode

ProtectedcreateNodes

• createNodes(
      uri: URI,
      symbols: DocumentSymbol[] | DocumentSymbol[],
  ): MonacoOutlineSymbolInformationNode[]

  Parameters

  • uri: URI
  • symbols: DocumentSymbol[] | DocumentSymbol[]

  Returns MonacoOutlineSymbolInformationNode[]

ProtectedcreateProviderRootNode

• createProviderRootNode(
      uri: URI,
      displayName: string,
      children: MonacoOutlineSymbolInformationNode[],
  ): MonacoOutlineSymbolInformationNode

  Parameters

  • uri: URI
  • displayName: string
  • children: MonacoOutlineSymbolInformationNode[]

  Returns MonacoOutlineSymbolInformationNode

ProtectedcreateRoots

• createRoots(
      model: ITextModel | ITextModel,
      token: CancellationToken,
      editorSelection?: Range,
  ): Promise<MonacoOutlineSymbolInformationNode[]>

  Parameters

  • model: ITextModel | ITextModel
  • token: CancellationToken
  • OptionaleditorSelection: Range

  Returns Promise<MonacoOutlineSymbolInformationNode[]>

ProtectedgetDetail

• getDetail(symbol: DocumentSymbol): string

  Parameters

  • symbol: DocumentSymbol

  Returns string

ProtectedgetFullRange

• getFullRange(documentSymbol: DocumentSymbol): Range

  Returns with a range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to determine if the clients cursor is inside the symbol to reveal in the symbol in the UI. This allows to obtain the range including the associated comments.

  See: DocumentSymbol#range for more details.

  Parameters

  • documentSymbol: DocumentSymbol

  Returns Range

ProtectedgetName

• getName(symbol: DocumentSymbol): string

  Parameters

  • symbol: DocumentSymbol

  Returns string

ProtectedgetNameRange

• getNameRange(documentSymbol: DocumentSymbol): Range

  The range that should be selected and revealed when this symbol is being picked, e.g the name of a function. Must be contained by the getSelectionRange.

  See: DocumentSymbol#selectionRange for more details.

  Parameters

  • documentSymbol: DocumentSymbol

  Returns Range

ProtectedhandleCurrentEditorChanged

• handleCurrentEditorChanged(): void

  Returns void

ProtectedorderByPosition

• orderByPosition(symbol: DocumentSymbol, symbol2: DocumentSymbol): number

  Parameters

  • symbol: DocumentSymbol
  • symbol2: DocumentSymbol

  Returns number

ProtectedparentContains

• parentContains(
      candidate: Range | DocumentSymbol,
      parent: Range | DocumentSymbol,
      rangeBased: boolean,
  ): boolean

  Returns true if candidate is strictly contained inside parent

  If the argument is a DocumentSymbol, then getFullRange will be used to retrieve the range of the underlying symbol.

  Parameters

  • candidate: Range | DocumentSymbol
  • parent: Range | DocumentSymbol
  • rangeBased: boolean

  Returns boolean

ProtectedselectInEditor

• selectInEditor(
      node: MonacoOutlineSymbolInformationNode,
      options?: EditorOpenerOptions,
  ): Promise<void>

  Parameters

  • node: MonacoOutlineSymbolInformationNode
  • Optionaloptions: EditorOpenerOptions

  Returns Promise<void>

ProtectedshouldExpand

• shouldExpand(symbol: DocumentSymbol): boolean

  Parameters

  • symbol: DocumentSymbol

  Returns boolean

ProtectedupdateOutline

• updateOutline(editorSelection?: Range): Promise<void>

  Parameters

  • OptionaleditorSelection: Range

  Returns Promise<void>