Gutter extended
Represents a gutter within a TextEditor.
See TextEditor::addGutter for information on creating a gutter.
Gutter Destruction
::destroy()
Destroys the gutter.
Event Subscription
::onDidChangeVisible(callback)
Calls your callback
when the gutter's visibility changes.
Argument | Description |
---|---|
callback(gutter) |
|
gutter |
The gutter whose visibility changed. |
Return values |
---|
Returns a Disposable on which |
::onDidDestroy(callback)
Calls your callback
when the gutter is destroyed.
Argument | Description |
---|---|
callback() |
Return values |
---|
Returns a Disposable on which |
Visibility
::hide()
Hide the gutter.
::show()
Show the gutter.
::decorateMarker(marker, decorationParams)
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.
Argument | Description |
---|---|
marker |
A DisplayMarker you want this decoration to follow. |
decorationParams |
An Object representing the decoration. It is passed to TextEditor::decorateMarker as its |
.type |
Caveat: set to |
Return values |
---|
Returns a Decoration object |