<link rel="stylesheet" href="/_merged_assets/_static/search/noscript.css">
Atom Community Logo Atom Community API Getting Started Toggle darkmode

Outline GitHub

A replacement of the outline functionality from atom-ide-ui. Presents symbols of an active text editor in a tree view.

screenshot of outline feature

API

Outline

Properties

outlineTrees

OutlineTree[]

OutlineProvider

Properties

grammarScopes

readonly string[]

name

string

priority

number

updateOnEdit

(optional)
boolean

Methods

getOutline

Parameters

editor
TextEditor

Returns

Promise<undefined|null|Outline>

OutlineTree

Properties

children

OutlineTree[]

endPosition

(optional)
Point

icon

(optional)
string

kind

(optional)
OutlineTreeKind

landingPosition

(optional)
Point

plainText

(optional)
string

representativeName

(optional)
string

startPosition

Point

tokenizedText

(optional)
TokenizedText

TextToken

Properties

kind

TokenKind

value

string

OutlineTreeKind

TokenKind

TokenizedText