Chapter 1: Getting Started

Chapter 2: Using Atom

Chapter 3: Hacking Atom

Chapter 4: Behind Atom

Reference: API

Appendix A: Resources

Appendix B: FAQ

Appendix C: Shadow DOM

Appendix D: Upgrading to 1.0 APIs

Appendix E: Atom server-side APIs

WorkspaceCenter Essential

Represents the workspace at the center of the entire window.

Event Subscription

::observeTextEditors(callback)

Invoke the given callback with all current and future text editors in the workspace center.

Argument Description

callback

Function to be called with current and future text editors.

editor

An TextEditor that is present in ::getTextEditors at the time of subscription or that is added at some later time.
Return values

Returns a Disposable on which .dispose() can be called to unsubscribe.

::observePaneItems(callback)

Invoke the given callback with all current and future panes items in the workspace center.

Argument Description

callback

Function to be called with current and future pane items.

item

An item that is present in ::getPaneItems at the time of subscription or that is added at some later time.
Return values

Returns a Disposable on which .dispose() can be called to unsubscribe.

::onDidChangeActivePaneItem(callback)

Invoke the given callback when the active pane item changes.

Because observers are invoked synchronously, it’s important not to perform any expensive operations via this method. Consider ::onDidStopChangingActivePaneItem to delay operations until after changes stop occurring.

Argument Description

callback

Function to be called when the active pane item changes.

item

The active pane item.
Return values

Returns a Disposable on which .dispose() can be called to unsubscribe.

::onDidStopChangingActivePaneItem(callback)

Invoke the given callback when the active pane item stops changing.

Observers are called asynchronously 100ms after the last active pane item change. Handling changes here rather than in the synchronous ::onDidChangeActivePaneItem prevents unneeded work if the user is quickly changing or closing tabs and ensures critical UI feedback, like changing the highlighted tab, gets priority over work that can be done asynchronously.

Argument Description

callback

Function to be called when the active pane item stopts changing.

item

The active pane item.
Return values

Returns a Disposable on which .dispose() can be called to unsubscribe.

::observeActivePaneItem(callback)

Invoke the given callback with the current active pane item and with all future active pane items in the workspace center.

Argument Description

callback

Function to be called when the active pane item changes.

item

The current active pane item.
Return values

Returns a Disposable on which .dispose() can be called to unsubscribe.

Extended Methods

::onDidAddPane(callback)

Invoke the given callback when a pane is added to the workspace center.

Argument Description

callback

Function to be called panes are added.

event

Object with the following keys:

pane

The added pane.
Return values

Returns a Disposable on which .dispose() can be called to unsubscribe.

::onWillDestroyPane(callback)

Invoke the given callback before a pane is destroyed in the workspace center.

Argument Description

callback

Function to be called before panes are destroyed.

event

Object with the following keys:

pane

The pane to be destroyed.
Return values

Returns a Disposable on which .dispose() can be called to unsubscribe.

::onDidDestroyPane(callback)

Invoke the given callback when a pane is destroyed in the workspace center.

Argument Description

callback

Function to be called panes are destroyed.

event

Object with the following keys:

pane

The destroyed pane.
Return values

Returns a Disposable on which .dispose() can be called to unsubscribe.

::observePanes(callback)

Invoke the given callback with all current and future panes in the workspace center.

Argument Description

callback

Function to be called with current and future panes.

pane

A Pane that is present in ::getPanes at the time of subscription or that is added at some later time.
Return values

Returns a Disposable on which .dispose() can be called to unsubscribe.

::onDidChangeActivePane(callback)

Invoke the given callback when the active pane changes.

Argument Description

callback

Function to be called when the active pane changes.

pane

A Pane that is the current return value of ::getActivePane.
Return values

Returns a Disposable on which .dispose() can be called to unsubscribe.

::observeActivePane(callback)

Invoke the given callback with the current active pane and when the active pane changes.

Argument Description

callback

Function to be called with the current and future active# panes.

pane

A Pane that is the current return value of ::getActivePane.
Return values

Returns a Disposable on which .dispose() can be called to unsubscribe.

::onDidAddPaneItem(callback)

Invoke the given callback when a pane item is added to the workspace center.

Argument Description

callback

Function to be called when pane items are added.

event

Object with the following keys:

item

The added pane item.

pane

Pane containing the added item.

index

Number indicating the index of the added item in its pane.
Return values

Returns a Disposable on which .dispose() can be called to unsubscribe.

::onWillDestroyPaneItem(callback)

Invoke the given callback when a pane item is about to be destroyed, before the user is prompted to save it.

Argument Description

callback

Function to be called before pane items are destroyed.

event

Object with the following keys:

item

The item to be destroyed.

pane

Pane containing the item to be destroyed.

index

Number indicating the index of the item to be destroyed in its pane.
Return values

Returns a Disposable on which .dispose can be called to unsubscribe.

::onDidDestroyPaneItem(callback)

Invoke the given callback when a pane item is destroyed.

Argument Description

callback

Function to be called when pane items are destroyed.

event

Object with the following keys:

item

The destroyed item.

pane

Pane containing the destroyed item.

index

Number indicating the index of the destroyed item in its pane.
Return values

Returns a Disposable on which .dispose can be called to unsubscribe.

::onDidAddTextEditor(callback)

Invoke the given callback when a text editor is added to the workspace center.

Argument Description

callback

Function to be called when panes are added.

event

Object with the following keys:

textEditor

TextEditor that was added.

pane

Pane containing the added text editor.

index

Number indicating the index of the added text editor in its pane.
Return values

Returns a Disposable on which .dispose() can be called to unsubscribe.

Pane Items

::getPaneItems()

Get all pane items in the workspace center.

Return values

Returns an Array of items.

::getActivePaneItem()

Get the active Pane’s active item.

Return values

Returns an pane item Object.

::getTextEditors()

Get all text editors in the workspace center.

Return values

Returns an Array of TextEditors.

::getActiveTextEditor()

Get the active item if it is an TextEditor.

Return values

Returns an TextEditor or undefined if the current active item is not an TextEditor.

Panes

This section only has Extended methods.

Extended Methods

::getPanes()

Get all panes in the workspace center.

Return values

Returns an Array of Panes.

::getActivePane()

Get the active Pane.

Return values

Returns a Pane.

::activateNextPane()

Make the next pane active.

::activatePreviousPane()

Make the previous pane active.