Atom

Represents a gutter within a TextEditor.

See TextEditor::addGutter for information on creating a gutter.

Destroys the gutter.

Calls your callback when the gutter's visibility changes.

callback(gutter)

Function

gutter

The gutter whose visibility changed.

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

Calls your callback when the gutter is destroyed.

callback()

Function

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

Hide the gutter.

Show the gutter.

Determine whether the gutter is visible.

Returns a Boolean.

Add a decoration that tracks a DisplayMarker. When the marker moves, is invalidated, or is destroyed, the decoration will be updated to reflect the marker's state.

marker

A DisplayMarker you want this decoration to follow.

decorationParams

An Object representing the decoration. It is passed to TextEditor::decorateMarker as its decorationParams and so supports all options documented there.

.type

Caveat: set to 'line-number' if this is the line-number gutter, 'gutter' otherwise. This cannot be overridden.

Returns a Decoration object

Gutter extended

Gutter Destruction

::destroy()

Event Subscription

::onDidChangeVisible(callback)

::onDidDestroy(callback)

Visibility

::hide()

::show()

::isVisible()

::decorateMarker(marker, decorationParams)