{ "AtomEnvironment": [ { "name": "clipboard", "text": "clipboard", "description": "A {Clipboard} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-clipboard", "leftLabel": "Clipboard", "type": "property" }, { "name": "commands", "text": "commands", "description": "A {CommandRegistry} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-commands", "leftLabel": "CommandRegistry", "type": "property" }, { "name": "config", "text": "config", "description": "A {Config} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-config", "leftLabel": "Config", "type": "property" }, { "name": "contextMenu", "text": "contextMenu", "description": "A {ContextMenuManager} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-contextMenu", "leftLabel": "ContextMenuManager", "type": "property" }, { "name": "deserializers", "text": "deserializers", "description": "A {DeserializerManager} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-deserializers", "leftLabel": "DeserializerManager", "type": "property" }, { "name": "grammars", "text": "grammars", "description": "A {GrammarRegistry} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-grammars", "leftLabel": "GrammarRegistry", "type": "property" }, { "name": "history", "text": "history", "description": "A {HistoryManager} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-history", "leftLabel": "HistoryManager", "type": "property" }, { "name": "keymaps", "text": "keymaps", "description": "A {KeymapManager} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-keymaps", "leftLabel": "KeymapManager", "type": "property" }, { "name": "menu", "text": "menu", "description": "A {MenuManager} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-menu", "leftLabel": "MenuManager", "type": "property" }, { "name": "notifications", "text": "notifications", "description": "A {NotificationManager} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-notifications", "leftLabel": "NotificationManager", "type": "property" }, { "name": "packages", "text": "packages", "description": "A {PackageManager} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-packages", "leftLabel": "PackageManager", "type": "property" }, { "name": "project", "text": "project", "description": "A {Project} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-project", "leftLabel": "Project", "type": "property" }, { "name": "styles", "text": "styles", "description": "A {StyleManager} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-styles", "leftLabel": "StyleManager", "type": "property" }, { "name": "textEditors", "text": "textEditors", "description": "A {TextEditorRegistry} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-textEditors", "leftLabel": "TextEditorRegistry", "type": "property" }, { "name": "themes", "text": "themes", "description": "A {ThemeManager} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-themes", "leftLabel": "ThemeManager", "type": "property" }, { "name": "tooltips", "text": "tooltips", "description": "A {TooltipManager} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-tooltips", "leftLabel": "TooltipManager", "type": "property" }, { "name": "views", "text": "views", "description": "A {ViewRegistry} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-views", "leftLabel": "ViewRegistry", "type": "property" }, { "name": "workspace", "text": "workspace", "description": "A {Workspace} instance ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-workspace", "leftLabel": "Workspace", "type": "property" }, { "name": "beep", "text": "beep()", "snippet": null, "description": "Visually and audibly trigger a beep. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-beep", "type": "method" }, { "name": "center", "text": "center()", "snippet": null, "description": "Move current window to the center of the screen. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-center", "type": "method" }, { "name": "close", "text": "close()", "snippet": null, "description": "Close the current window. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-close", "type": "method" }, { "name": "confirm", "text": null, "snippet": "confirm(${1:options})", "description": "A flexible way to open a dialog akin to an alert dialog.", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-confirm", "leftLabel": "Number", "type": "method" }, { "name": "executeJavaScriptInDevTools", "text": "executeJavaScriptInDevTools()", "snippet": null, "description": "Execute code in dev tools. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-executeJavaScriptInDevTools", "type": "method" }, { "name": "focus", "text": "focus()", "snippet": null, "description": "Focus the current window. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-focus", "type": "method" }, { "name": "getCurrentWindow", "text": "getCurrentWindow()", "snippet": null, "description": "Get the current window ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-getCurrentWindow", "type": "method" }, { "name": "getLoadSettings", "text": "getLoadSettings()", "snippet": null, "description": "Get the load settings for the current window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-getLoadSettings", "leftLabel": "Object", "type": "method" }, { "name": "getPosition", "text": "getPosition()", "snippet": null, "description": "Get the position of current window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-getPosition", "leftLabel": "Object", "type": "method" }, { "name": "getReleaseChannel", "text": "getReleaseChannel()", "snippet": null, "description": "Gets the release channel of the Atom application.", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-getReleaseChannel", "leftLabel": "String", "type": "method" }, { "name": "getSize", "text": "getSize()", "snippet": null, "description": "Get the size of current window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-getSize", "leftLabel": "Object", "type": "method" }, { "name": "getVersion", "text": "getVersion()", "snippet": null, "description": "Get the version of the Atom application.", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-getVersion", "leftLabel": "String", "type": "method" }, { "name": "getWindowLoadTime", "text": "getWindowLoadTime()", "snippet": null, "description": "Get the time taken to completely load the current window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-getWindowLoadTime", "leftLabel": "Number", "type": "method" }, { "name": "hide", "text": "hide()", "snippet": null, "description": "Hide the current window. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-hide", "type": "method" }, { "name": "inDevMode", "text": "inDevMode()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-inDevMode", "leftLabel": "Boolean", "type": "method" }, { "name": "inSafeMode", "text": "inSafeMode()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-inSafeMode", "leftLabel": "Boolean", "type": "method" }, { "name": "inSpecMode", "text": "inSpecMode()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-inSpecMode", "leftLabel": "Boolean", "type": "method" }, { "name": "isFullScreen", "text": "isFullScreen()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-isFullScreen", "leftLabel": "Boolean", "type": "method" }, { "name": "isMaximized", "text": "isMaximized()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-isMaximized", "leftLabel": "Boolean", "type": "method" }, { "name": "isReleasedVersion", "text": "isReleasedVersion()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-isReleasedVersion", "leftLabel": "Boolean", "type": "method" }, { "name": "onDidBeep", "text": null, "snippet": "onDidBeep(${1:callback})", "description": "Invoke the given callback whenever {::beep} is called.", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-onDidBeep", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidThrowError", "text": null, "snippet": "onDidThrowError(${1:callback})", "description": "Invoke the given callback whenever there is an unhandled error.", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-onDidThrowError", "leftLabel": "Disposable", "type": "method" }, { "name": "onWillThrowError", "text": null, "snippet": "onWillThrowError(${1:callback})", "description": "Invoke the given callback when there is an unhandled error, but\nbefore the devtools pop open", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-onWillThrowError", "leftLabel": "Disposable", "type": "method" }, { "name": "open", "text": null, "snippet": "open(${1:params})", "description": "Open a new Atom window using the given options.", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-open", "type": "method" }, { "name": "openDevTools", "text": "openDevTools()", "snippet": null, "description": "Open the dev tools for the current window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-openDevTools", "leftLabel": "Promise", "type": "method" }, { "name": "pickFolder", "text": null, "snippet": "pickFolder(${1:callback})", "description": "Prompt the user to select one or more folders.", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-pickFolder", "type": "method" }, { "name": "reload", "text": "reload()", "snippet": null, "description": "Reload the current window. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-reload", "type": "method" }, { "name": "restartApplication", "text": "restartApplication()", "snippet": null, "description": "Relaunch the entire application. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-restartApplication", "type": "method" }, { "name": "setFullScreen", "text": "setFullScreen()", "snippet": null, "description": "Set the full screen state of the current window. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-setFullScreen", "type": "method" }, { "name": "setPosition", "text": null, "snippet": "setPosition(${1:x}, ${2:y})", "description": "Set the position of current window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-setPosition", "type": "method" }, { "name": "setSize", "text": null, "snippet": "setSize(${1:width}, ${2:height})", "description": "Set the size of current window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-setSize", "type": "method" }, { "name": "show", "text": "show()", "snippet": null, "description": "Show the current window. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-show", "type": "method" }, { "name": "toggleDevTools", "text": "toggleDevTools()", "snippet": null, "description": "Toggle the visibility of the dev tools for the current window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-toggleDevTools", "leftLabel": "Promise", "type": "method" }, { "name": "toggleFullScreen", "text": "toggleFullScreen()", "snippet": null, "description": "Toggle the full screen state of the current window. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-toggleFullScreen", "type": "method" }, { "name": "whenShellEnvironmentLoaded", "text": null, "snippet": "whenShellEnvironmentLoaded(${1:callback})", "description": "Invoke the given callback as soon as the shell environment is\nloaded (or immediately if it was already loaded).", "descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-whenShellEnvironmentLoaded", "type": "method" } ], "BufferedNodeProcess": [ { "name": "constructor", "text": null, "snippet": "constructor(${1:options})", "description": "Runs the given Node script by spawning a new child process.", "descriptionMoreURL": "https://atom.io/docs/api/latest/BufferedNodeProcess#instance-constructor", "type": "method" } ], "BufferedProcess": [ { "name": "constructor", "text": null, "snippet": "constructor(${1:options})", "description": "Runs the given command by spawning a new child process.", "descriptionMoreURL": "https://atom.io/docs/api/latest/BufferedProcess#instance-constructor", "type": "method" }, { "name": "kill", "text": "kill()", "snippet": null, "description": "Terminate the process.", "descriptionMoreURL": "https://atom.io/docs/api/latest/BufferedProcess#instance-kill", "type": "method" }, { "name": "onWillThrowError", "text": null, "snippet": "onWillThrowError(${1:callback})", "description": "Will call your callback when an error will be raised by the process.\nUsually this is due to the command not being available or not on the PATH.\nYou can call `handle()` on the object passed to your callback to indicate\nthat you have handled this error.", "descriptionMoreURL": "https://atom.io/docs/api/latest/BufferedProcess#instance-onWillThrowError", "leftLabel": "Disposable", "type": "method" } ], "Clipboard": [ { "name": "read", "text": "read()", "snippet": null, "description": "Read the text from the clipboard.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Clipboard#instance-read", "leftLabel": "String", "type": "method" }, { "name": "readWithMetadata", "text": "readWithMetadata()", "snippet": null, "description": "Read the text from the clipboard and return both the text and the\nassociated metadata.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Clipboard#instance-readWithMetadata", "leftLabel": "Object", "type": "method" }, { "name": "write", "text": null, "snippet": "write(${1:text}, ${2:metadata})", "description": "Write the given text to the clipboard.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Clipboard#instance-write", "type": "method" } ], "Color": [ { "name": "toHexString", "text": "toHexString()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Color#instance-toHexString", "leftLabel": "String", "type": "method" }, { "name": "toRGBAString", "text": "toRGBAString()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Color#instance-toRGBAString", "leftLabel": "String", "type": "method" } ], "CommandRegistry": [ { "name": "add", "text": "add()", "snippet": null, "description": "Add one or more command listeners associated with a selector.", "descriptionMoreURL": "https://atom.io/docs/api/latest/CommandRegistry#instance-add", "leftLabel": "Disposable", "type": "method" }, { "name": "dispatch", "text": null, "snippet": "dispatch(${1:target}, ${2:commandName})", "description": "Simulate the dispatch of a command on a DOM node.", "descriptionMoreURL": "https://atom.io/docs/api/latest/CommandRegistry#instance-dispatch", "type": "method" }, { "name": "findCommands", "text": null, "snippet": "findCommands(${1:params})", "description": "Find all registered commands matching a query.", "descriptionMoreURL": "https://atom.io/docs/api/latest/CommandRegistry#instance-findCommands", "leftLabel": "Array", "type": "method" }, { "name": "onDidDispatch", "text": null, "snippet": "onDidDispatch(${1:callback})", "description": "Invoke the given callback after dispatching a command event.", "descriptionMoreURL": "https://atom.io/docs/api/latest/CommandRegistry#instance-onDidDispatch", "type": "method" }, { "name": "onWillDispatch", "text": null, "snippet": "onWillDispatch(${1:callback})", "description": "Invoke the given callback before dispatching a command event.", "descriptionMoreURL": "https://atom.io/docs/api/latest/CommandRegistry#instance-onWillDispatch", "type": "method" } ], "CompositeDisposable": [ { "name": "add", "text": null, "snippet": "add(${1:...disposables})", "description": "Add disposables to be disposed when the composite is disposed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/CompositeDisposable#instance-add", "type": "method" }, { "name": "clear", "text": "clear()", "snippet": null, "description": "Clear all disposables. They will not be disposed by the next call\nto dispose. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/CompositeDisposable#instance-clear", "type": "method" }, { "name": "constructor", "text": "constructor()", "snippet": null, "description": "Construct an instance, optionally with one or more disposables ", "descriptionMoreURL": "https://atom.io/docs/api/latest/CompositeDisposable#instance-constructor", "type": "method" }, { "name": "delete", "text": "delete()", "snippet": null, "description": "Alias to {CompositeDisposable::remove} ", "descriptionMoreURL": "https://atom.io/docs/api/latest/CompositeDisposable#instance-delete", "type": "method" }, { "name": "dispose", "text": "dispose()", "snippet": null, "description": "Dispose all disposables added to this composite disposable.", "descriptionMoreURL": "https://atom.io/docs/api/latest/CompositeDisposable#instance-dispose", "type": "method" }, { "name": "remove", "text": null, "snippet": "remove(${1:disposable})", "description": "Remove a previously added disposable.", "descriptionMoreURL": "https://atom.io/docs/api/latest/CompositeDisposable#instance-remove", "type": "method" } ], "Config": [ { "name": "get", "text": null, "snippet": "get(${1:keyPath}, ${2:options})", "description": "Retrieves the setting for the given key.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-get", "leftLabel": null, "type": "method" }, { "name": "getAll", "text": null, "snippet": "getAll(${1:keyPath}, ${2:options})", "description": "Get all of the values for the given key-path, along with their\nassociated scope selector.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-getAll", "leftLabel": "Array", "type": "method" }, { "name": "getSchema", "text": null, "snippet": "getSchema(${1:keyPath})", "description": "Retrieve the schema for a specific key path. The schema will tell\nyou what type the keyPath expects, and other metadata about the config\noption.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-getSchema", "leftLabel": "Object", "type": "method" }, { "name": "getSources", "text": "getSources()", "snippet": null, "description": "Get an {Array} of all of the `source` {String}s with which\nsettings have been added via {::set}. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-getSources", "type": "method" }, { "name": "getUserConfigPath", "text": "getUserConfigPath()", "snippet": null, "description": "Get the {String} path to the config file being used. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-getUserConfigPath", "type": "method" }, { "name": "observe", "text": null, "snippet": "observe(${1:keyPath}, ${2:options}, ${3:callback})", "description": "Add a listener for changes to a given key path. This is different\nthan {::onDidChange} in that it will immediately call your callback with the\ncurrent value of the config entry.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-observe", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChange", "text": null, "snippet": "onDidChange(${1:keyPath}, ${2:options}, ${3:callback})", "description": "Add a listener for changes to a given key path. If `keyPath` is\nnot specified, your callback will be called on changes to any key.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-onDidChange", "leftLabel": "Disposable", "type": "method" }, { "name": "set", "text": null, "snippet": "set(${1:keyPath}, ${2:value}, ${3:options})", "description": "Sets the value for a configuration setting.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-set", "leftLabel": "Boolean", "type": "method" }, { "name": "transact", "text": null, "snippet": "transact(${1:callback})", "description": "Suppress calls to handler functions registered with {::onDidChange}\nand {::observe} for the duration of `callback`. After `callback` executes,\nhandlers will be called once if the value for their key-path has changed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-transact", "type": "method" }, { "name": "unset", "text": null, "snippet": "unset(${1:keyPath}, ${2:options})", "description": "Restore the setting at `keyPath` to its default value.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-unset", "type": "method" } ], "ContextMenuManager": [ { "name": "add", "text": null, "snippet": "add(${1:itemsBySelector})", "description": "Add context menu items scoped by CSS selectors.", "descriptionMoreURL": "https://atom.io/docs/api/latest/ContextMenuManager#instance-add", "leftLabel": "Disposable", "type": "method" } ], "Cursor": [ { "name": "clearSelection", "text": "clearSelection()", "snippet": null, "description": "Deselects the current selection.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-clearSelection", "type": "method" }, { "name": "compare", "text": null, "snippet": "compare(${1:otherCursor})", "description": "Compare this cursor's buffer position to another cursor's buffer position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-compare", "type": "method" }, { "name": "getBeginningOfCurrentWordBufferPosition", "text": null, "snippet": "getBeginningOfCurrentWordBufferPosition(${1:options})", "description": "Retrieves the buffer position of where the current word starts.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getBeginningOfCurrentWordBufferPosition", "leftLabel": "Range", "type": "method" }, { "name": "getBeginningOfNextWordBufferPosition", "text": null, "snippet": "getBeginningOfNextWordBufferPosition(${1:options})", "description": "Retrieves the buffer position of where the next word starts.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getBeginningOfNextWordBufferPosition", "leftLabel": "Range", "type": "method" }, { "name": "getBufferColumn", "text": "getBufferColumn()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getBufferColumn", "leftLabel": null, "type": "method" }, { "name": "getBufferPosition", "text": "getBufferPosition()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getBufferPosition", "leftLabel": null, "type": "method" }, { "name": "getBufferRow", "text": "getBufferRow()", "snippet": null, "description": "Retrieves the cursor's current buffer row.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getBufferRow", "type": "method" }, { "name": "getCurrentBufferLine", "text": "getCurrentBufferLine()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getCurrentBufferLine", "leftLabel": null, "type": "method" }, { "name": "getCurrentLineBufferRange", "text": null, "snippet": "getCurrentLineBufferRange(${1:options})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getCurrentLineBufferRange", "leftLabel": null, "type": "method" }, { "name": "getCurrentParagraphBufferRange", "text": "getCurrentParagraphBufferRange()", "snippet": null, "description": "Retrieves the range for the current paragraph.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getCurrentParagraphBufferRange", "leftLabel": "Range", "type": "method" }, { "name": "getCurrentWordBufferRange", "text": null, "snippet": "getCurrentWordBufferRange(${1:options})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getCurrentWordBufferRange", "leftLabel": null, "type": "method" }, { "name": "getCurrentWordPrefix", "text": "getCurrentWordPrefix()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getCurrentWordPrefix", "leftLabel": null, "type": "method" }, { "name": "getEndOfCurrentWordBufferPosition", "text": null, "snippet": "getEndOfCurrentWordBufferPosition(${1:options})", "description": "Retrieves the buffer position of where the current word ends.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getEndOfCurrentWordBufferPosition", "leftLabel": "Range", "type": "method" }, { "name": "getIndentLevel", "text": "getIndentLevel()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getIndentLevel", "leftLabel": null, "type": "method" }, { "name": "getMarker", "text": "getMarker()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getMarker", "leftLabel": "DisplayMarker", "type": "method" }, { "name": "getNextWordBoundaryBufferPosition", "text": null, "snippet": "getNextWordBoundaryBufferPosition(${1:options})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getNextWordBoundaryBufferPosition", "leftLabel": null, "type": "method" }, { "name": "getPreviousWordBoundaryBufferPosition", "text": null, "snippet": "getPreviousWordBoundaryBufferPosition(${1:options})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getPreviousWordBoundaryBufferPosition", "leftLabel": null, "type": "method" }, { "name": "getScopeDescriptor", "text": "getScopeDescriptor()", "snippet": null, "description": "Retrieves the scope descriptor for the cursor's current position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getScopeDescriptor", "leftLabel": "ScopeDescriptor", "type": "method" }, { "name": "getScreenColumn", "text": "getScreenColumn()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getScreenColumn", "leftLabel": null, "type": "method" }, { "name": "getScreenPosition", "text": "getScreenPosition()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getScreenPosition", "leftLabel": "Point", "type": "method" }, { "name": "getScreenRow", "text": "getScreenRow()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getScreenRow", "leftLabel": null, "type": "method" }, { "name": "hasPrecedingCharactersOnLine", "text": "hasPrecedingCharactersOnLine()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-hasPrecedingCharactersOnLine", "leftLabel": null, "type": "method" }, { "name": "isAtBeginningOfLine", "text": "isAtBeginningOfLine()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-isAtBeginningOfLine", "leftLabel": null, "type": "method" }, { "name": "isAtEndOfLine", "text": "isAtEndOfLine()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-isAtEndOfLine", "leftLabel": null, "type": "method" }, { "name": "isBetweenWordAndNonWord", "text": "isBetweenWordAndNonWord()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-isBetweenWordAndNonWord", "leftLabel": null, "type": "method" }, { "name": "isInsideWord", "text": null, "snippet": "isInsideWord(${1:options})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-isInsideWord", "leftLabel": null, "type": "method" }, { "name": "isLastCursor", "text": "isLastCursor()", "snippet": null, "description": "Identifies if this cursor is the last in the {TextEditor}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-isLastCursor", "leftLabel": "Boolean", "type": "method" }, { "name": "isSurroundedByWhitespace", "text": "isSurroundedByWhitespace()", "snippet": null, "description": "Identifies if the cursor is surrounded by whitespace.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-isSurroundedByWhitespace", "leftLabel": "Boolean", "type": "method" }, { "name": "moveDown", "text": null, "snippet": "moveDown(${1:rowCount}, ${2:options})", "description": "Moves the cursor down one screen row.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveDown", "type": "method" }, { "name": "moveLeft", "text": null, "snippet": "moveLeft(${1:columnCount}, ${2:options})", "description": "Moves the cursor left one screen column.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveLeft", "type": "method" }, { "name": "moveRight", "text": null, "snippet": "moveRight(${1:columnCount}, ${2:options})", "description": "Moves the cursor right one screen column.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveRight", "type": "method" }, { "name": "moveToBeginningOfLine", "text": "moveToBeginningOfLine()", "snippet": null, "description": "Moves the cursor to the beginning of the buffer line.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToBeginningOfLine", "type": "method" }, { "name": "moveToBeginningOfNextParagraph", "text": "moveToBeginningOfNextParagraph()", "snippet": null, "description": "Moves the cursor to the beginning of the next paragraph", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToBeginningOfNextParagraph", "type": "method" }, { "name": "moveToBeginningOfNextWord", "text": "moveToBeginningOfNextWord()", "snippet": null, "description": "Moves the cursor to the beginning of the next word.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToBeginningOfNextWord", "type": "method" }, { "name": "moveToBeginningOfPreviousParagraph", "text": "moveToBeginningOfPreviousParagraph()", "snippet": null, "description": "Moves the cursor to the beginning of the previous paragraph", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToBeginningOfPreviousParagraph", "type": "method" }, { "name": "moveToBeginningOfScreenLine", "text": "moveToBeginningOfScreenLine()", "snippet": null, "description": "Moves the cursor to the beginning of the line.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToBeginningOfScreenLine", "type": "method" }, { "name": "moveToBeginningOfWord", "text": "moveToBeginningOfWord()", "snippet": null, "description": "Moves the cursor to the beginning of the word.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToBeginningOfWord", "type": "method" }, { "name": "moveToBottom", "text": "moveToBottom()", "snippet": null, "description": "Moves the cursor to the bottom of the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToBottom", "type": "method" }, { "name": "moveToEndOfLine", "text": "moveToEndOfLine()", "snippet": null, "description": "Moves the cursor to the end of the buffer line.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToEndOfLine", "type": "method" }, { "name": "moveToEndOfScreenLine", "text": "moveToEndOfScreenLine()", "snippet": null, "description": "Moves the cursor to the end of the line.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToEndOfScreenLine", "type": "method" }, { "name": "moveToEndOfWord", "text": "moveToEndOfWord()", "snippet": null, "description": "Moves the cursor to the end of the word.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToEndOfWord", "type": "method" }, { "name": "moveToFirstCharacterOfLine", "text": "moveToFirstCharacterOfLine()", "snippet": null, "description": "Moves the cursor to the beginning of the first character in the\nline.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToFirstCharacterOfLine", "type": "method" }, { "name": "moveToNextSubwordBoundary", "text": "moveToNextSubwordBoundary()", "snippet": null, "description": "Moves the cursor to the next subword boundary.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToNextSubwordBoundary", "type": "method" }, { "name": "moveToNextWordBoundary", "text": "moveToNextWordBoundary()", "snippet": null, "description": "Moves the cursor to the next word boundary.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToNextWordBoundary", "type": "method" }, { "name": "moveToPreviousSubwordBoundary", "text": "moveToPreviousSubwordBoundary()", "snippet": null, "description": "Moves the cursor to the previous subword boundary.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToPreviousSubwordBoundary", "type": "method" }, { "name": "moveToPreviousWordBoundary", "text": "moveToPreviousWordBoundary()", "snippet": null, "description": "Moves the cursor to the previous word boundary.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToPreviousWordBoundary", "type": "method" }, { "name": "moveToTop", "text": "moveToTop()", "snippet": null, "description": "Moves the cursor to the top of the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToTop", "type": "method" }, { "name": "moveUp", "text": null, "snippet": "moveUp(${1:rowCount}, ${2:options})", "description": "Moves the cursor up one screen row.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveUp", "type": "method" }, { "name": "onDidChangePosition", "text": null, "snippet": "onDidChangePosition(${1:callback})", "description": "Calls your `callback` when the cursor has been moved.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-onDidChangePosition", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroy", "text": null, "snippet": "onDidDestroy(${1:callback})", "description": "Calls your `callback` when the cursor is destroyed", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-onDidDestroy", "leftLabel": "Disposable", "type": "method" }, { "name": "setBufferPosition", "text": null, "snippet": "setBufferPosition(${1:bufferPosition}, ${2:options})", "description": "Moves a cursor to a given buffer position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-setBufferPosition", "type": "method" }, { "name": "setScreenPosition", "text": null, "snippet": "setScreenPosition(${1:screenPosition}, ${2:options})", "description": "Moves a cursor to a given screen position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-setScreenPosition", "type": "method" }, { "name": "skipLeadingWhitespace", "text": "skipLeadingWhitespace()", "snippet": null, "description": "Moves the cursor to the beginning of the buffer line, skipping all\nwhitespace.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-skipLeadingWhitespace", "type": "method" }, { "name": "subwordRegExp", "text": null, "snippet": "subwordRegExp(${1:options})", "description": "Get the RegExp used by the cursor to determine what a \"subword\" is.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-subwordRegExp", "leftLabel": "RegExp", "type": "method" }, { "name": "wordRegExp", "text": null, "snippet": "wordRegExp(${1:options})", "description": "Get the RegExp used by the cursor to determine what a \"word\" is.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-wordRegExp", "leftLabel": "RegExp", "type": "method" } ], "Decoration": [ { "name": "destroy", "text": "destroy()", "snippet": null, "description": "Destroy this marker decoration.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Decoration#instance-destroy", "type": "method" }, { "name": "getId", "text": "getId()", "snippet": null, "description": "An id unique across all {Decoration} objects", "descriptionMoreURL": "https://atom.io/docs/api/latest/Decoration#instance-getId", "type": "method" }, { "name": "getMarker", "text": "getMarker()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Decoration#instance-getMarker", "leftLabel": "Decoration", "type": "method" }, { "name": "getProperties", "text": "getProperties()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Decoration#instance-getProperties", "leftLabel": "Decoration", "type": "method" }, { "name": "isType", "text": null, "snippet": "isType(${1:type})", "description": "Check if this decoration is of type `type`", "descriptionMoreURL": "https://atom.io/docs/api/latest/Decoration#instance-isType", "leftLabel": "Boolean", "type": "method" }, { "name": "onDidChangeProperties", "text": null, "snippet": "onDidChangeProperties(${1:callback})", "description": "When the {Decoration} is updated via {Decoration::update}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Decoration#instance-onDidChangeProperties", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroy", "text": null, "snippet": "onDidDestroy(${1:callback})", "description": "Invoke the given callback when the {Decoration} is destroyed", "descriptionMoreURL": "https://atom.io/docs/api/latest/Decoration#instance-onDidDestroy", "leftLabel": "Disposable", "type": "method" }, { "name": "setProperties", "text": null, "snippet": "setProperties(${1:newProperties})", "description": "Update the marker with new Properties. Allows you to change the decoration's class.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Decoration#instance-setProperties", "type": "method" } ], "DeserializerManager": [ { "name": "add", "text": null, "snippet": "add(${1:deserializers})", "description": "Register the given class(es) as deserializers.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DeserializerManager#instance-add", "type": "method" }, { "name": "deserialize", "text": null, "snippet": "deserialize(${1:state})", "description": "Deserialize the state and params.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DeserializerManager#instance-deserialize", "type": "method" } ], "Directory": [ { "name": "constructor", "text": null, "snippet": "constructor(${1:directoryPath}, ${2:symlink})", "description": "Configures a new Directory instance, no files are accessed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-constructor", "type": "method" }, { "name": "contains", "text": null, "snippet": "contains(${1:pathToCheck})", "description": "Determines if the given path (real or symbolic) is inside this\ndirectory. This method does not actually check if the path exists, it just\nchecks if the path is under this directory.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-contains", "leftLabel": "Boolean", "type": "method" }, { "name": "create", "text": null, "snippet": "create(${1:mode})", "description": "Creates the directory on disk that corresponds to `::getPath()` if\nno such directory already exists.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-create", "leftLabel": "Promise", "type": "method" }, { "name": "exists", "text": "exists()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-exists", "leftLabel": "Boolean", "type": "method" }, { "name": "existsSync", "text": "existsSync()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-existsSync", "leftLabel": "Boolean", "type": "method" }, { "name": "getBaseName", "text": "getBaseName()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-getBaseName", "leftLabel": "String", "type": "method" }, { "name": "getEntries", "text": null, "snippet": "getEntries(${1:callback})", "description": "Reads file entries in this directory from disk asynchronously.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-getEntries", "type": "method" }, { "name": "getEntriesSync", "text": "getEntriesSync()", "snippet": null, "description": "Reads file entries in this directory from disk synchronously.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-getEntriesSync", "leftLabel": "Array", "type": "method" }, { "name": "getFile", "text": null, "snippet": "getFile(${1:filename})", "description": "Traverse within this Directory to a child File. This method doesn't\nactually check to see if the File exists, it just creates the File object.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-getFile", "leftLabel": "File", "type": "method" }, { "name": "getParent", "text": "getParent()", "snippet": null, "description": "Traverse to the parent directory.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-getParent", "leftLabel": "Directory", "type": "method" }, { "name": "getPath", "text": "getPath()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-getPath", "leftLabel": "String", "type": "method" }, { "name": "getRealPathSync", "text": "getRealPathSync()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-getRealPathSync", "leftLabel": "String", "type": "method" }, { "name": "getSubdirectory", "text": null, "snippet": "getSubdirectory(${1:dirname})", "description": "Traverse within this a Directory to a child Directory. This method\ndoesn't actually check to see if the Directory exists, it just creates the\nDirectory object.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-getSubdirectory", "leftLabel": "Directory", "type": "method" }, { "name": "isDirectory", "text": "isDirectory()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-isDirectory", "leftLabel": "Boolean", "type": "method" }, { "name": "isFile", "text": "isFile()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-isFile", "leftLabel": "Boolean", "type": "method" }, { "name": "isRoot", "text": "isRoot()", "snippet": null, "description": "Return a {Boolean}, true if this {Directory} is the root directory\nof the filesystem, or false if it isn't. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-isRoot", "type": "method" }, { "name": "isSymbolicLink", "text": "isSymbolicLink()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-isSymbolicLink", "leftLabel": "Boolean", "type": "method" }, { "name": "onDidChange", "text": null, "snippet": "onDidChange(${1:callback})", "description": "Invoke the given callback when the directory's contents change.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-onDidChange", "leftLabel": "Disposable", "type": "method" }, { "name": "relativize", "text": "relativize()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-relativize", "leftLabel": "String", "type": "method" } ], "DisplayMarker": [ { "name": "clearTail", "text": "clearTail()", "snippet": null, "description": "Removes the marker's tail. After calling the marker's head position\nwill be reported as its current tail position until the tail is planted\nagain. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-clearTail", "type": "method" }, { "name": "compare", "text": null, "snippet": "compare(${1:other})", "description": "Compares this marker to another based on their ranges.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-compare", "leftLabel": "Number", "type": "method" }, { "name": "copy", "text": null, "snippet": "copy(${1:properties})", "description": "Creates and returns a new {DisplayMarker} with the same properties as\nthis marker.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-copy", "leftLabel": "DisplayMarker", "type": "method" }, { "name": "destroy", "text": "destroy()", "snippet": null, "description": "Destroys the marker, causing it to emit the 'destroyed' event. Once\ndestroyed, a marker cannot be restored by undo/redo operations. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-destroy", "type": "method" }, { "name": "getBufferRange", "text": "getBufferRange()", "snippet": null, "description": "Gets the buffer range of this marker.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getBufferRange", "leftLabel": "Range", "type": "method" }, { "name": "getEndBufferPosition", "text": "getEndBufferPosition()", "snippet": null, "description": "Retrieves the buffer position of the marker's end. This will always be\ngreater than or equal to the result of {DisplayMarker::getStartBufferPosition}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getEndBufferPosition", "leftLabel": "Point", "type": "method" }, { "name": "getEndScreenPosition", "text": null, "snippet": "getEndScreenPosition(${1:options})", "description": "Retrieves the screen position of the marker's end. This will always be\ngreater than or equal to the result of {DisplayMarker::getStartScreenPosition}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getEndScreenPosition", "leftLabel": "Point", "type": "method" }, { "name": "getHeadBufferPosition", "text": "getHeadBufferPosition()", "snippet": null, "description": "Retrieves the buffer position of the marker's head.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getHeadBufferPosition", "leftLabel": "Point", "type": "method" }, { "name": "getHeadScreenPosition", "text": null, "snippet": "getHeadScreenPosition(${1:options})", "description": "Retrieves the screen position of the marker's head.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getHeadScreenPosition", "leftLabel": "Point", "type": "method" }, { "name": "getInvalidationStrategy", "text": "getInvalidationStrategy()", "snippet": null, "description": "Get the invalidation strategy for this marker.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getInvalidationStrategy", "leftLabel": "String", "type": "method" }, { "name": "getProperties", "text": "getProperties()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getProperties", "leftLabel": "Object", "type": "method" }, { "name": "getScreenRange", "text": "getScreenRange()", "snippet": null, "description": "Gets the screen range of this marker.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getScreenRange", "leftLabel": "Range", "type": "method" }, { "name": "getStartBufferPosition", "text": "getStartBufferPosition()", "snippet": null, "description": "Retrieves the buffer position of the marker's start. This will always be\nless than or equal to the result of {DisplayMarker::getEndBufferPosition}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getStartBufferPosition", "leftLabel": "Point", "type": "method" }, { "name": "getStartScreenPosition", "text": null, "snippet": "getStartScreenPosition(${1:options})", "description": "Retrieves the screen position of the marker's start. This will always be\nless than or equal to the result of {DisplayMarker::getEndScreenPosition}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getStartScreenPosition", "leftLabel": "Point", "type": "method" }, { "name": "getTailBufferPosition", "text": "getTailBufferPosition()", "snippet": null, "description": "Retrieves the buffer position of the marker's tail.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getTailBufferPosition", "leftLabel": "Point", "type": "method" }, { "name": "getTailScreenPosition", "text": null, "snippet": "getTailScreenPosition(${1:options})", "description": "Retrieves the screen position of the marker's tail.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getTailScreenPosition", "leftLabel": "Point", "type": "method" }, { "name": "hasTail", "text": "hasTail()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-hasTail", "leftLabel": "Boolean", "type": "method" }, { "name": "isDestroyed", "text": "isDestroyed()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-isDestroyed", "leftLabel": "Boolean", "type": "method" }, { "name": "isEqual", "text": null, "snippet": "isEqual(${1:other})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-isEqual", "leftLabel": "Boolean", "type": "method" }, { "name": "isExclusive", "text": "isExclusive()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-isExclusive", "leftLabel": "Boolean", "type": "method" }, { "name": "isReversed", "text": "isReversed()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-isReversed", "leftLabel": "Boolean", "type": "method" }, { "name": "isValid", "text": "isValid()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-isValid", "leftLabel": "Boolean", "type": "method" }, { "name": "matchesProperties", "text": "matchesProperties()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-matchesProperties", "leftLabel": null, "type": "method" }, { "name": "onDidChange", "text": null, "snippet": "onDidChange(${1:callback})", "description": "Invoke the given callback when the state of the marker changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-onDidChange", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroy", "text": null, "snippet": "onDidDestroy(${1:callback})", "description": "Invoke the given callback when the marker is destroyed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-onDidDestroy", "leftLabel": "Disposable", "type": "method" }, { "name": "plantTail", "text": "plantTail()", "snippet": null, "description": "Plants the marker's tail at the current head position. After calling\nthe marker's tail position will be its head position at the time of the\ncall, regardless of where the marker's head is moved. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-plantTail", "type": "method" }, { "name": "setBufferRange", "text": null, "snippet": "setBufferRange(${1:bufferRange}, ${2:properties})", "description": "Modifies the buffer range of this marker.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-setBufferRange", "type": "method" }, { "name": "setHeadBufferPosition", "text": null, "snippet": "setHeadBufferPosition(${1:bufferPosition})", "description": "Sets the buffer position of the marker's head.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-setHeadBufferPosition", "type": "method" }, { "name": "setHeadScreenPosition", "text": null, "snippet": "setHeadScreenPosition(${1:screenPosition}, ${2:options})", "description": "Sets the screen position of the marker's head.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-setHeadScreenPosition", "type": "method" }, { "name": "setProperties", "text": null, "snippet": "setProperties(${1:properties})", "description": "Merges an {Object} containing new properties into the marker's\nexisting properties.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-setProperties", "type": "method" }, { "name": "setScreenRange", "text": null, "snippet": "setScreenRange(${1:screenRange}, ${2:options})", "description": "Modifies the screen range of this marker.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-setScreenRange", "type": "method" }, { "name": "setTailBufferPosition", "text": null, "snippet": "setTailBufferPosition(${1:bufferPosition})", "description": "Sets the buffer position of the marker's tail.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-setTailBufferPosition", "type": "method" }, { "name": "setTailScreenPosition", "text": null, "snippet": "setTailScreenPosition(${1:screenPosition}, ${2:options})", "description": "Sets the screen position of the marker's tail.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-setTailScreenPosition", "type": "method" } ], "DisplayMarkerLayer": [ { "name": "clear", "text": "clear()", "snippet": null, "description": "Destroy all markers in this layer. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-clear", "type": "method" }, { "name": "destroy", "text": "destroy()", "snippet": null, "description": "Destroy this layer. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-destroy", "type": "method" }, { "name": "findMarkers", "text": null, "snippet": "findMarkers(${1:properties})", "description": "Find markers in the layer conforming to the given parameters.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-findMarkers", "leftLabel": "Array", "type": "method" }, { "name": "getMarker", "text": "getMarker()", "snippet": null, "description": "Get an existing marker by its id.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-getMarker", "leftLabel": "DisplayMarker", "type": "method" }, { "name": "getMarkerCount", "text": "getMarkerCount()", "snippet": null, "description": "Get the number of markers in the marker layer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-getMarkerCount", "leftLabel": "Number", "type": "method" }, { "name": "getMarkers", "text": "getMarkers()", "snippet": null, "description": "Get all markers in the layer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-getMarkers", "leftLabel": "Array", "type": "method" }, { "name": "isDestroyed", "text": "isDestroyed()", "snippet": null, "description": "Determine whether this layer has been destroyed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-isDestroyed", "leftLabel": "Boolean", "type": "method" }, { "name": "markBufferPosition", "text": null, "snippet": "markBufferPosition(${1:bufferPosition}, ${2:options})", "description": "Create a marker on this layer with its head at the given buffer\nposition and no tail.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-markBufferPosition", "leftLabel": "DisplayMarker", "type": "method" }, { "name": "markBufferRange", "text": null, "snippet": "markBufferRange(${1:range}, ${2:options})", "description": "Create a marker with the given buffer range.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-markBufferRange", "leftLabel": "DisplayMarker", "type": "method" }, { "name": "markScreenPosition", "text": null, "snippet": "markScreenPosition(${1:screenPosition}, ${2:options})", "description": "Create a marker on this layer with its head at the given screen\nposition and no tail.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-markScreenPosition", "leftLabel": "DisplayMarker", "type": "method" }, { "name": "markScreenRange", "text": null, "snippet": "markScreenRange(${1:range}, ${2:options})", "description": "Create a marker with the given screen range.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-markScreenRange", "leftLabel": "DisplayMarker", "type": "method" }, { "name": "onDidCreateMarker", "text": null, "snippet": "onDidCreateMarker(${1:callback})", "description": "Subscribe to be notified synchronously whenever markers are created\non this layer. *Avoid this method for optimal performance when interacting\nwith layers that could contain large numbers of markers.*", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-onDidCreateMarker", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroy", "text": "onDidDestroy()", "snippet": null, "description": "Subscribe to be notified synchronously when this layer is destroyed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-onDidDestroy", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidUpdate", "text": null, "snippet": "onDidUpdate(${1:callback})", "description": "Subscribe to be notified asynchronously whenever markers are\ncreated, updated, or destroyed on this layer. *Prefer this method for\noptimal performance when interacting with layers that could contain large\nnumbers of markers.*", "descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-onDidUpdate", "leftLabel": "Disposable", "type": "method" } ], "Disposable": [ { "name": "constructor", "text": null, "snippet": "constructor(${1:disposalAction})", "description": "Construct a Disposable", "descriptionMoreURL": "https://atom.io/docs/api/latest/Disposable#instance-constructor", "type": "method" }, { "name": "dispose", "text": "dispose()", "snippet": null, "description": "Perform the disposal action, indicating that the resource associated\nwith this disposable is no longer needed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Disposable#instance-dispose", "type": "method" } ], "Dock": [ { "name": "activate", "text": "activate()", "snippet": null, "description": "Show the dock and focus its active {Pane}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-activate", "type": "method" }, { "name": "activateNextPane", "text": "activateNextPane()", "snippet": null, "description": "Make the next pane active.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-activateNextPane", "type": "method" }, { "name": "activatePreviousPane", "text": "activatePreviousPane()", "snippet": null, "description": "Make the previous pane active.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-activatePreviousPane", "type": "method" }, { "name": "getActivePane", "text": "getActivePane()", "snippet": null, "description": "Get the active {Pane}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-getActivePane", "leftLabel": "Pane", "type": "method" }, { "name": "getActivePaneItem", "text": "getActivePaneItem()", "snippet": null, "description": "Get the active {Pane}'s active item.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-getActivePaneItem", "leftLabel": "Object", "type": "method" }, { "name": "getPaneItems", "text": "getPaneItems()", "snippet": null, "description": "Get all pane items in the dock.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-getPaneItems", "leftLabel": "Array", "type": "method" }, { "name": "getPanes", "text": "getPanes()", "snippet": null, "description": "Get all panes in the dock.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-getPanes", "leftLabel": "Array", "type": "method" }, { "name": "hide", "text": "hide()", "snippet": null, "description": "Hide the dock and activate the {WorkspaceCenter} if the dock was\nwas previously focused.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-hide", "type": "method" }, { "name": "isVisible", "text": "isVisible()", "snippet": null, "description": "Check if the dock is visible.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-isVisible", "leftLabel": "Boolean", "type": "method" }, { "name": "observeActivePane", "text": null, "snippet": "observeActivePane(${1:callback})", "description": "Invoke the given callback with the current active pane and when\nthe active pane changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-observeActivePane", "leftLabel": "Disposable", "type": "method" }, { "name": "observeActivePaneItem", "text": null, "snippet": "observeActivePaneItem(${1:callback})", "description": "Invoke the given callback with the current active pane item and\nwith all future active pane items in the dock.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-observeActivePaneItem", "leftLabel": "Disposable", "type": "method" }, { "name": "observePaneItems", "text": null, "snippet": "observePaneItems(${1:callback})", "description": "Invoke the given callback with all current and future panes items\nin the dock.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-observePaneItems", "leftLabel": "Disposable", "type": "method" }, { "name": "observePanes", "text": null, "snippet": "observePanes(${1:callback})", "description": "Invoke the given callback with all current and future panes in the\ndock.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-observePanes", "leftLabel": "Disposable", "type": "method" }, { "name": "observeVisible", "text": null, "snippet": "observeVisible(${1:callback})", "description": "Invoke the given callback with the current and all future visibilities of the dock.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-observeVisible", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidAddPane", "text": null, "snippet": "onDidAddPane(${1:callback})", "description": "Invoke the given callback when a pane is added to the dock.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onDidAddPane", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidAddPaneItem", "text": null, "snippet": "onDidAddPaneItem(${1:callback})", "description": "Invoke the given callback when a pane item is added to the dock.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onDidAddPaneItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeActivePane", "text": null, "snippet": "onDidChangeActivePane(${1:callback})", "description": "Invoke the given callback when the active pane changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onDidChangeActivePane", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeActivePaneItem", "text": null, "snippet": "onDidChangeActivePaneItem(${1:callback})", "description": "Invoke the given callback when the active pane item changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onDidChangeActivePaneItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeVisible", "text": null, "snippet": "onDidChangeVisible(${1:callback})", "description": "Invoke the given callback when the visibility of the dock changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onDidChangeVisible", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroyPane", "text": null, "snippet": "onDidDestroyPane(${1:callback})", "description": "Invoke the given callback when a pane is destroyed in the dock.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onDidDestroyPane", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroyPaneItem", "text": null, "snippet": "onDidDestroyPaneItem(${1:callback})", "description": "Invoke the given callback when a pane item is destroyed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onDidDestroyPaneItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidStopChangingActivePaneItem", "text": null, "snippet": "onDidStopChangingActivePaneItem(${1:callback})", "description": "Invoke the given callback when the active pane item stops\nchanging.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onDidStopChangingActivePaneItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onWillDestroyPane", "text": null, "snippet": "onWillDestroyPane(${1:callback})", "description": "Invoke the given callback before a pane is destroyed in the\ndock.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onWillDestroyPane", "leftLabel": "Disposable", "type": "method" }, { "name": "onWillDestroyPaneItem", "text": null, "snippet": "onWillDestroyPaneItem(${1:callback})", "description": "Invoke the given callback when a pane item is about to be\ndestroyed, before the user is prompted to save it.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onWillDestroyPaneItem", "leftLabel": "Disposable", "type": "method" }, { "name": "show", "text": "show()", "snippet": null, "description": "Show the dock without focusing it.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-show", "type": "method" }, { "name": "toggle", "text": "toggle()", "snippet": null, "description": "Toggle the dock's visibility without changing the {Workspace}'s\nactive pane container.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-toggle", "type": "method" } ], "Emitter": [ { "name": "clear", "text": "clear()", "snippet": null, "description": "Clear out any existing subscribers. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/Emitter#instance-clear", "type": "method" }, { "name": "constructor", "text": "constructor()", "snippet": null, "description": "Construct an emitter.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Emitter#instance-constructor", "type": "method" }, { "name": "dispose", "text": "dispose()", "snippet": null, "description": "Unsubscribe all handlers. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/Emitter#instance-dispose", "type": "method" }, { "name": "emit", "text": null, "snippet": "emit(${1:eventName}, ${2:value})", "description": "Invoke handlers registered via {::on} for the given event name.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Emitter#instance-emit", "type": "method" }, { "name": "on", "text": null, "snippet": "on(${1:eventName}, ${2:handler})", "description": "Register the given handler function to be invoked whenever events by\nthe given name are emitted via {::emit}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Emitter#instance-on", "leftLabel": "Disposable", "type": "method" }, { "name": "once", "text": null, "snippet": "once(${1:eventName}, ${2:handler})", "description": "Register the given handler function to be invoked the next time an\nevents with the given name is emitted via {::emit}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Emitter#instance-once", "leftLabel": "Disposable", "type": "method" }, { "name": "preempt", "text": null, "snippet": "preempt(${1:eventName}, ${2:handler})", "description": "Register the given handler function to be invoked *before* all\nother handlers existing at the time of subscription whenever events by the\ngiven name are emitted via {::emit}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Emitter#instance-preempt", "leftLabel": "Disposable", "type": "method" } ], "File": [ { "name": "constructor", "text": null, "snippet": "constructor(${1:filePath}, ${2:symlink})", "description": "Configures a new File instance, no files are accessed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-constructor", "type": "method" }, { "name": "create", "text": "create()", "snippet": null, "description": "Creates the file on disk that corresponds to `::getPath()` if no\nsuch file already exists.", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-create", "leftLabel": "Promise", "type": "method" }, { "name": "createReadStream", "text": "createReadStream()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-createReadStream", "leftLabel": null, "type": "method" }, { "name": "createWriteStream", "text": "createWriteStream()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-createWriteStream", "leftLabel": null, "type": "method" }, { "name": "exists", "text": "exists()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-exists", "leftLabel": "Boolean", "type": "method" }, { "name": "existsSync", "text": "existsSync()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-existsSync", "leftLabel": "Boolean", "type": "method" }, { "name": "getBaseName", "text": "getBaseName()", "snippet": null, "description": "Return the {String} filename without any directory information. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-getBaseName", "type": "method" }, { "name": "getDigest", "text": "getDigest()", "snippet": null, "description": "Get the SHA-1 digest of this file", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-getDigest", "leftLabel": "String", "type": "method" }, { "name": "getDigestSync", "text": "getDigestSync()", "snippet": null, "description": "Get the SHA-1 digest of this file", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-getDigestSync", "leftLabel": "String", "type": "method" }, { "name": "getEncoding", "text": "getEncoding()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-getEncoding", "leftLabel": "String", "type": "method" }, { "name": "getParent", "text": "getParent()", "snippet": null, "description": "Return the {Directory} that contains this file. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-getParent", "type": "method" }, { "name": "getPath", "text": "getPath()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-getPath", "leftLabel": "String", "type": "method" }, { "name": "getRealPath", "text": "getRealPath()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-getRealPath", "leftLabel": "String", "type": "method" }, { "name": "getRealPathSync", "text": "getRealPathSync()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-getRealPathSync", "leftLabel": "String", "type": "method" }, { "name": "isDirectory", "text": "isDirectory()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-isDirectory", "leftLabel": "Boolean", "type": "method" }, { "name": "isFile", "text": "isFile()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-isFile", "leftLabel": "Boolean", "type": "method" }, { "name": "isSymbolicLink", "text": "isSymbolicLink()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-isSymbolicLink", "leftLabel": "Boolean", "type": "method" }, { "name": "onDidChange", "text": null, "snippet": "onDidChange(${1:callback})", "description": "Invoke the given callback when the file's contents change.", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-onDidChange", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDelete", "text": null, "snippet": "onDidDelete(${1:callback})", "description": "Invoke the given callback when the file is deleted.", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-onDidDelete", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidRename", "text": null, "snippet": "onDidRename(${1:callback})", "description": "Invoke the given callback when the file's path changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-onDidRename", "leftLabel": "Disposable", "type": "method" }, { "name": "onWillThrowWatchError", "text": null, "snippet": "onWillThrowWatchError(${1:callback})", "description": "Invoke the given callback when there is an error with the watch.\nWhen your callback has been invoked, the file will have unsubscribed from\nthe file watches.", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-onWillThrowWatchError", "type": "method" }, { "name": "read", "text": null, "snippet": "read(${1:flushCache})", "description": "Reads the contents of the file.", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-read", "leftLabel": null, "type": "method" }, { "name": "setEncoding", "text": null, "snippet": "setEncoding(${1:encoding})", "description": "Sets the file's character set encoding name.", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-setEncoding", "type": "method" }, { "name": "write", "text": null, "snippet": "write(${1:text})", "description": "Overwrites the file with the given text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-write", "leftLabel": "Promise", "type": "method" }, { "name": "writeSync", "text": null, "snippet": "writeSync(${1:text})", "description": "Overwrites the file with the given text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-writeSync", "leftLabel": null, "type": "method" } ], "GitRepository": [ { "name": "checkoutHead", "text": null, "snippet": "checkoutHead(${1:path})", "description": "Restore the contents of a path in the working directory and index\nto the version at `HEAD`.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-checkoutHead", "leftLabel": "Boolean", "type": "method" }, { "name": "checkoutReference", "text": null, "snippet": "checkoutReference(${1:reference}, ${2:create})", "description": "Checks out a branch in your repository.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-checkoutReference", "leftLabel": null, "type": "method" }, { "name": "destroy", "text": "destroy()", "snippet": null, "description": "Destroy this {GitRepository} object.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-destroy", "type": "method" }, { "name": "getAheadBehindCount", "text": null, "snippet": "getAheadBehindCount(${1:reference}, ${2:path})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getAheadBehindCount", "leftLabel": null, "type": "method" }, { "name": "getCachedPathStatus", "text": null, "snippet": "getCachedPathStatus(${1:path})", "description": "Get the cached status for the given path.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getCachedPathStatus", "leftLabel": "Number", "type": "method" }, { "name": "getCachedUpstreamAheadBehindCount", "text": null, "snippet": "getCachedUpstreamAheadBehindCount(${1:path})", "description": "Get the cached ahead/behind commit counts for the current branch's\nupstream branch.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getCachedUpstreamAheadBehindCount", "leftLabel": "Object", "type": "method" }, { "name": "getConfigValue", "text": null, "snippet": "getConfigValue(${1:key}, ${2:path})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getConfigValue", "leftLabel": null, "type": "method" }, { "name": "getDiffStats", "text": null, "snippet": "getDiffStats(${1:path})", "description": "Retrieves the number of lines added and removed to a path.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getDiffStats", "leftLabel": "Object", "type": "method" }, { "name": "getDirectoryStatus", "text": null, "snippet": "getDirectoryStatus(${1:path})", "description": "Get the status of a directory in the repository's working directory.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getDirectoryStatus", "leftLabel": "Number", "type": "method" }, { "name": "getLineDiffs", "text": null, "snippet": "getLineDiffs(${1:path}, ${2:text})", "description": "Retrieves the line diffs comparing the `HEAD` version of the given\npath and the given text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getLineDiffs", "leftLabel": "Array", "type": "method" }, { "name": "getOriginURL", "text": null, "snippet": "getOriginURL(${1:path})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getOriginURL", "leftLabel": null, "type": "method" }, { "name": "getPath", "text": "getPath()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getPath", "leftLabel": "String", "type": "method" }, { "name": "getPathStatus", "text": null, "snippet": "getPathStatus(${1:path})", "description": "Get the status of a single path in the repository.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getPathStatus", "leftLabel": "Number", "type": "method" }, { "name": "getReferenceTarget", "text": null, "snippet": "getReferenceTarget(${1:reference}, ${2:path})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getReferenceTarget", "leftLabel": "String", "type": "method" }, { "name": "getReferences", "text": null, "snippet": "getReferences(${1:path})", "description": "Gets all the local and remote references.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getReferences", "leftLabel": "Object", "type": "method" }, { "name": "getShortHead", "text": null, "snippet": "getShortHead(${1:path})", "description": "Retrieves a shortened version of the HEAD reference value.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getShortHead", "leftLabel": "String", "type": "method" }, { "name": "getType", "text": "getType()", "snippet": null, "description": "A {String} indicating the type of version control system used by\nthis repository.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getType", "leftLabel": null, "type": "method" }, { "name": "getUpstreamBranch", "text": null, "snippet": "getUpstreamBranch(${1:path})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getUpstreamBranch", "leftLabel": null, "type": "method" }, { "name": "getWorkingDirectory", "text": "getWorkingDirectory()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getWorkingDirectory", "leftLabel": "String", "type": "method" }, { "name": "hasBranch", "text": "hasBranch()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-hasBranch", "leftLabel": null, "type": "method" }, { "name": "isDestroyed", "text": "isDestroyed()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-isDestroyed", "leftLabel": "Boolean", "type": "method" }, { "name": "isPathIgnored", "text": null, "snippet": "isPathIgnored(${1:path})", "description": "Is the given path ignored?", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-isPathIgnored", "leftLabel": "Boolean", "type": "method" }, { "name": "isPathModified", "text": null, "snippet": "isPathModified(${1:path})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-isPathModified", "leftLabel": null, "type": "method" }, { "name": "isPathNew", "text": null, "snippet": "isPathNew(${1:path})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-isPathNew", "leftLabel": null, "type": "method" }, { "name": "isProjectAtRoot", "text": "isProjectAtRoot()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-isProjectAtRoot", "leftLabel": null, "type": "method" }, { "name": "isStatusModified", "text": null, "snippet": "isStatusModified(${1:status})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-isStatusModified", "leftLabel": null, "type": "method" }, { "name": "isStatusNew", "text": null, "snippet": "isStatusNew(${1:status})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-isStatusNew", "leftLabel": null, "type": "method" }, { "name": "isSubmodule", "text": null, "snippet": "isSubmodule(${1:path})", "description": "Is the given path a submodule in the repository?", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-isSubmodule", "leftLabel": "Boolean", "type": "method" }, { "name": "onDidChangeStatus", "text": null, "snippet": "onDidChangeStatus(${1:callback})", "description": "Invoke the given callback when a specific file's status has\nchanged. When a file is updated, reloaded, etc, and the status changes, this\nwill be fired.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-onDidChangeStatus", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeStatuses", "text": null, "snippet": "onDidChangeStatuses(${1:callback})", "description": "Invoke the given callback when a multiple files' statuses have\nchanged. For example, on window focus, the status of all the paths in the\nrepo is checked. If any of them have changed, this will be fired. Call\n{::getPathStatus(path)} to get the status for your path of choice.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-onDidChangeStatuses", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroy", "text": null, "snippet": "onDidDestroy(${1:callback})", "description": "Invoke the given callback when this GitRepository's destroy() method\nis invoked.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-onDidDestroy", "leftLabel": "Disposable", "type": "method" }, { "name": "relativize", "text": "relativize()", "snippet": null, "description": "Makes a path relative to the repository's working directory.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-relativize", "type": "method" } ], "Grammar": [ { "name": "onDidUpdate", "text": null, "snippet": "onDidUpdate(${1:callback})", "description": "Invoke the given callback when this grammar is updated due to a\ngrammar it depends on being added or removed from the registry.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Grammar#instance-onDidUpdate", "leftLabel": "Disposable", "type": "method" }, { "name": "tokenizeLine", "text": null, "snippet": "tokenizeLine(${1:line}, ${2:ruleStack}, ${3:firstLine})", "description": "Tokenize the line of text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Grammar#instance-tokenizeLine", "leftLabel": "Object", "type": "method" }, { "name": "tokenizeLines", "text": null, "snippet": "tokenizeLines(${1:text})", "description": "Tokenize all lines in the given text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Grammar#instance-tokenizeLines", "leftLabel": "Array", "type": "method" } ], "GrammarRegistry": [ { "name": "addGrammar", "text": null, "snippet": "addGrammar(${1:grammar})", "description": "Add a grammar to this registry.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-addGrammar", "leftLabel": "Disposable", "type": "method" }, { "name": "getGrammars", "text": "getGrammars()", "snippet": null, "description": "Get all the grammars in this registry.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-getGrammars", "leftLabel": "Array", "type": "method" }, { "name": "grammarForScopeName", "text": null, "snippet": "grammarForScopeName(${1:scopeName})", "description": "Get a grammar with the given scope name.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-grammarForScopeName", "leftLabel": "Grammar", "type": "method" }, { "name": "loadGrammar", "text": null, "snippet": "loadGrammar(${1:grammarPath}, ${2:callback})", "description": "Read a grammar asynchronously and add it to the registry.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-loadGrammar", "leftLabel": null, "type": "method" }, { "name": "loadGrammarSync", "text": null, "snippet": "loadGrammarSync(${1:grammarPath})", "description": "Read a grammar synchronously and add it to this registry.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-loadGrammarSync", "leftLabel": "Grammar", "type": "method" }, { "name": "onDidAddGrammar", "text": null, "snippet": "onDidAddGrammar(${1:callback})", "description": "Invoke the given callback when a grammar is added to the registry.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-onDidAddGrammar", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidRemoveGrammar", "text": null, "snippet": "onDidRemoveGrammar(${1:callback})", "description": "Invoke the given callback when a grammar is removed from the registry.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-onDidRemoveGrammar", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidUpdateGrammar", "text": null, "snippet": "onDidUpdateGrammar(${1:callback})", "description": "Invoke the given callback when a grammar is updated due to a grammar\nit depends on being added or removed from the registry.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-onDidUpdateGrammar", "leftLabel": "Disposable", "type": "method" }, { "name": "readGrammar", "text": null, "snippet": "readGrammar(${1:grammarPath}, ${2:callback})", "description": "Read a grammar asynchronously but don't add it to the registry.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-readGrammar", "leftLabel": null, "type": "method" }, { "name": "readGrammarSync", "text": null, "snippet": "readGrammarSync(${1:grammarPath})", "description": "Read a grammar synchronously but don't add it to the registry.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-readGrammarSync", "leftLabel": "Grammar", "type": "method" }, { "name": "removeGrammarForScopeName", "text": null, "snippet": "removeGrammarForScopeName(${1:scopeName})", "description": "Remove the grammar with the given scope name.", "descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-removeGrammarForScopeName", "leftLabel": "Grammar", "type": "method" } ], "Gutter": [ { "name": "decorateMarker", "text": null, "snippet": "decorateMarker(${1:marker}, ${2:decorationParams})", "description": "Add a decoration that tracks a {DisplayMarker}. When the marker moves,\nis invalidated, or is destroyed, the decoration will be updated to reflect\nthe marker's state.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Gutter#instance-decorateMarker", "leftLabel": "Decoration", "type": "method" }, { "name": "destroy", "text": "destroy()", "snippet": null, "description": "Destroys the gutter.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Gutter#instance-destroy", "type": "method" }, { "name": "hide", "text": "hide()", "snippet": null, "description": "Hide the gutter.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Gutter#instance-hide", "type": "method" }, { "name": "isVisible", "text": "isVisible()", "snippet": null, "description": "Determine whether the gutter is visible.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Gutter#instance-isVisible", "leftLabel": "Boolean", "type": "method" }, { "name": "onDidChangeVisible", "text": null, "snippet": "onDidChangeVisible(${1:callback})", "description": "Calls your `callback` when the gutter's visibility changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Gutter#instance-onDidChangeVisible", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroy", "text": null, "snippet": "onDidDestroy(${1:callback})", "description": "Calls your `callback` when the gutter is destroyed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Gutter#instance-onDidDestroy", "leftLabel": "Disposable", "type": "method" }, { "name": "show", "text": "show()", "snippet": null, "description": "Show the gutter.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Gutter#instance-show", "type": "method" } ], "HistoryManager": [ { "name": "clearProjects", "text": "clearProjects()", "snippet": null, "description": "Clear all projects from the history.", "descriptionMoreURL": "https://atom.io/docs/api/latest/HistoryManager#instance-clearProjects", "type": "method" }, { "name": "getProjects", "text": "getProjects()", "snippet": null, "description": "Obtain a list of previously opened projects.", "descriptionMoreURL": "https://atom.io/docs/api/latest/HistoryManager#instance-getProjects", "leftLabel": "Array", "type": "method" }, { "name": "onDidChangeProjects", "text": null, "snippet": "onDidChangeProjects(${1:callback})", "description": "Invoke the given callback when the list of projects changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/HistoryManager#instance-onDidChangeProjects", "leftLabel": "Disposable", "type": "method" } ], "KeymapManager": [ { "name": "add", "text": null, "snippet": "add(${1:source}, ${2:bindings}, ${3:priority})", "description": "Add sets of key bindings grouped by CSS selector.", "descriptionMoreURL": "https://atom.io/docs/api/latest/KeymapManager#instance-add", "type": "method" }, { "name": "addKeystrokeResolver", "text": null, "snippet": "addKeystrokeResolver(${1:resolver})", "description": "Customize translation of raw keyboard events to keystroke strings.\nThis API is useful for working around Chrome bugs or changing how Atom\nresolves certain key combinations. If multiple resolvers are installed,\nthe most recently-added resolver returning a string for a given keystroke\ntakes precedence.", "descriptionMoreURL": "https://atom.io/docs/api/latest/KeymapManager#instance-addKeystrokeResolver", "leftLabel": "Disposable", "type": "method" }, { "name": "build", "text": null, "snippet": "build(${1:source}, ${2:bindings}, ${3:priority})", "description": "Construct [KeyBindings]{KeyBinding} from an object grouping them by CSS selector.", "descriptionMoreURL": "https://atom.io/docs/api/latest/KeymapManager#instance-build", "type": "method" }, { "name": "clear", "text": "clear()", "snippet": null, "description": "Clear all registered key bindings and enqueued keystrokes. For use\nin tests. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/KeymapManager#instance-clear", "type": "method" }, { "name": "constructor", "text": null, "snippet": "constructor(${1:options})", "description": "Create a new KeymapManager.", "descriptionMoreURL": "https://atom.io/docs/api/latest/KeymapManager#instance-constructor", "type": "method" }, { "name": "destroy", "text": "destroy()", "snippet": null, "description": "Unwatch all watched paths. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/KeymapManager#instance-destroy", "type": "method" }, { "name": "findKeyBindings", "text": null, "snippet": "findKeyBindings(${1:params})", "description": "Get the key bindings for a given command and optional target.", "descriptionMoreURL": "https://atom.io/docs/api/latest/KeymapManager#instance-findKeyBindings", "leftLabel": "Array", "type": "method" }, { "name": "getKeyBindings", "text": "getKeyBindings()", "snippet": null, "description": "Get all current key bindings.", "descriptionMoreURL": "https://atom.io/docs/api/latest/KeymapManager#instance-getKeyBindings", "leftLabel": "Array", "type": "method" }, { "name": "getPartialMatchTimeout", "text": "getPartialMatchTimeout()", "snippet": null, "description": "Get the number of milliseconds allowed before pending states caused\nby partial matches of multi-keystroke bindings are terminated.", "descriptionMoreURL": "https://atom.io/docs/api/latest/KeymapManager#instance-getPartialMatchTimeout", "leftLabel": "Number", "type": "method" }, { "name": "handleKeyboardEvent", "text": null, "snippet": "handleKeyboardEvent(${1:event})", "description": "Dispatch a custom event associated with the matching key binding for\nthe given `KeyboardEvent` if one can be found.", "descriptionMoreURL": "https://atom.io/docs/api/latest/KeymapManager#instance-handleKeyboardEvent", "type": "method" }, { "name": "keystrokeForKeyboardEvent", "text": null, "snippet": "keystrokeForKeyboardEvent(${1:event})", "description": "Translate a keydown event to a keystroke string.", "descriptionMoreURL": "https://atom.io/docs/api/latest/KeymapManager#instance-keystrokeForKeyboardEvent", "leftLabel": "String", "type": "method" }, { "name": "loadKeymap", "text": null, "snippet": "loadKeymap(${1:path}, ${2:options})", "description": "Load the key bindings from the given path.", "descriptionMoreURL": "https://atom.io/docs/api/latest/KeymapManager#instance-loadKeymap", "type": "method" }, { "name": "onDidFailToMatchBinding", "text": null, "snippet": "onDidFailToMatchBinding(${1:callback})", "description": "Invoke the given callback when one or more keystrokes fail to match\nany bindings.", "descriptionMoreURL": "https://atom.io/docs/api/latest/KeymapManager#instance-onDidFailToMatchBinding", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidFailToReadFile", "text": null, "snippet": "onDidFailToReadFile(${1:callback})", "description": "Invoke the given callback when a keymap file not able to be loaded.", "descriptionMoreURL": "https://atom.io/docs/api/latest/KeymapManager#instance-onDidFailToReadFile", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidMatchBinding", "text": null, "snippet": "onDidMatchBinding(${1:callback})", "description": "Invoke the given callback when one or more keystrokes completely\nmatch a key binding.", "descriptionMoreURL": "https://atom.io/docs/api/latest/KeymapManager#instance-onDidMatchBinding", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidPartiallyMatchBindings", "text": null, "snippet": "onDidPartiallyMatchBindings(${1:callback})", "description": "Invoke the given callback when one or more keystrokes partially\nmatch a binding.", "descriptionMoreURL": "https://atom.io/docs/api/latest/KeymapManager#instance-onDidPartiallyMatchBindings", "leftLabel": "Disposable", "type": "method" }, { "name": "watchKeymap", "text": null, "snippet": "watchKeymap(${1:path}, ${2:options})", "description": "Cause the keymap to reload the key bindings file at the given path\nwhenever it changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/KeymapManager#instance-watchKeymap", "type": "method" } ], "LayerDecoration": [ { "name": "destroy", "text": "destroy()", "snippet": null, "description": "Destroys the decoration. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/LayerDecoration#instance-destroy", "type": "method" }, { "name": "getProperties", "text": "getProperties()", "snippet": null, "description": "Get this decoration's properties.", "descriptionMoreURL": "https://atom.io/docs/api/latest/LayerDecoration#instance-getProperties", "leftLabel": "Object", "type": "method" }, { "name": "isDestroyed", "text": "isDestroyed()", "snippet": null, "description": "Determine whether this decoration is destroyed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/LayerDecoration#instance-isDestroyed", "leftLabel": "Boolean", "type": "method" }, { "name": "setProperties", "text": null, "snippet": "setProperties(${1:newProperties})", "description": "Set this decoration's properties.", "descriptionMoreURL": "https://atom.io/docs/api/latest/LayerDecoration#instance-setProperties", "type": "method" }, { "name": "setPropertiesForMarker", "text": null, "snippet": "setPropertiesForMarker(${1:marker}, ${2:properties})", "description": "Override the decoration properties for a specific marker.", "descriptionMoreURL": "https://atom.io/docs/api/latest/LayerDecoration#instance-setPropertiesForMarker", "type": "method" } ], "MarkerLayer": [ { "name": "clear", "text": "clear()", "snippet": null, "description": "Remove all markers from this layer. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/MarkerLayer#instance-clear", "type": "method" }, { "name": "copy", "text": "copy()", "snippet": null, "description": "Create a copy of this layer with markers in the same state and\nlocations. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/MarkerLayer#instance-copy", "type": "method" }, { "name": "destroy", "text": "destroy()", "snippet": null, "description": "Destroy this layer. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/MarkerLayer#instance-destroy", "type": "method" }, { "name": "findMarkers", "text": "findMarkers()", "snippet": null, "description": "Find markers in the layer conforming to the given parameters.", "descriptionMoreURL": "https://atom.io/docs/api/latest/MarkerLayer#instance-findMarkers", "type": "method" }, { "name": "getMarker", "text": "getMarker()", "snippet": null, "description": "Get an existing marker by its id.", "descriptionMoreURL": "https://atom.io/docs/api/latest/MarkerLayer#instance-getMarker", "leftLabel": "Marker", "type": "method" }, { "name": "getMarkerCount", "text": "getMarkerCount()", "snippet": null, "description": "Get the number of markers in the marker layer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/MarkerLayer#instance-getMarkerCount", "leftLabel": "Number", "type": "method" }, { "name": "getMarkers", "text": "getMarkers()", "snippet": null, "description": "Get all existing markers on the marker layer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/MarkerLayer#instance-getMarkers", "leftLabel": "Array", "type": "method" }, { "name": "isDestroyed", "text": "isDestroyed()", "snippet": null, "description": "Determine whether this layer has been destroyed. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/MarkerLayer#instance-isDestroyed", "type": "method" }, { "name": "markPosition", "text": null, "snippet": "markPosition(${1:position}, ${2:options})", "description": "Create a marker at with its head at the given position with no tail.", "descriptionMoreURL": "https://atom.io/docs/api/latest/MarkerLayer#instance-markPosition", "leftLabel": "Marker", "type": "method" }, { "name": "markRange", "text": null, "snippet": "markRange(${1:range}, ${2:options})", "description": "Create a marker with the given range.", "descriptionMoreURL": "https://atom.io/docs/api/latest/MarkerLayer#instance-markRange", "leftLabel": "Marker", "type": "method" }, { "name": "onDidCreateMarker", "text": null, "snippet": "onDidCreateMarker(${1:callback})", "description": "Subscribe to be notified synchronously whenever markers are created\non this layer. *Avoid this method for optimal performance when interacting\nwith layers that could contain large numbers of markers.*", "descriptionMoreURL": "https://atom.io/docs/api/latest/MarkerLayer#instance-onDidCreateMarker", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroy", "text": "onDidDestroy()", "snippet": null, "description": "Subscribe to be notified synchronously when this layer is destroyed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/MarkerLayer#instance-onDidDestroy", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidUpdate", "text": null, "snippet": "onDidUpdate(${1:callback})", "description": "Subscribe to be notified asynchronously whenever markers are\ncreated, updated, or destroyed on this layer. *Prefer this method for\noptimal performance when interacting with layers that could contain large\nnumbers of markers.*", "descriptionMoreURL": "https://atom.io/docs/api/latest/MarkerLayer#instance-onDidUpdate", "leftLabel": "Disposable", "type": "method" } ], "MenuManager": [ { "name": "add", "text": null, "snippet": "add(${1:items})", "description": "Adds the given items to the application menu.", "descriptionMoreURL": "https://atom.io/docs/api/latest/MenuManager#instance-add", "leftLabel": "Disposable", "type": "method" }, { "name": "update", "text": "update()", "snippet": null, "description": "Refreshes the currently visible menu. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/MenuManager#instance-update", "type": "method" } ], "Notification": [ { "name": "dismiss", "text": "dismiss()", "snippet": null, "description": "Dismisses the notification, removing it from the UI. Calling this\nprogrammatically will call all callbacks added via `onDidDismiss`.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Notification#instance-dismiss", "type": "method" }, { "name": "getMessage", "text": "getMessage()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Notification#instance-getMessage", "leftLabel": "String", "type": "method" }, { "name": "getType", "text": "getType()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Notification#instance-getType", "leftLabel": "String", "type": "method" }, { "name": "onDidDismiss", "text": null, "snippet": "onDidDismiss(${1:callback})", "description": "Invoke the given callback when the notification is dismissed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Notification#instance-onDidDismiss", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDisplay", "text": null, "snippet": "onDidDisplay(${1:callback})", "description": "Invoke the given callback when the notification is displayed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Notification#instance-onDidDisplay", "leftLabel": "Disposable", "type": "method" } ], "NotificationManager": [ { "name": "addError", "text": null, "snippet": "addError(${1:message}, ${2:options})", "description": "Add an error notification.", "descriptionMoreURL": "https://atom.io/docs/api/latest/NotificationManager#instance-addError", "leftLabel": "Notification", "type": "method" }, { "name": "addFatalError", "text": null, "snippet": "addFatalError(${1:message}, ${2:options})", "description": "Add a fatal error notification.", "descriptionMoreURL": "https://atom.io/docs/api/latest/NotificationManager#instance-addFatalError", "leftLabel": "Notification", "type": "method" }, { "name": "addInfo", "text": null, "snippet": "addInfo(${1:message}, ${2:options})", "description": "Add an informational notification.", "descriptionMoreURL": "https://atom.io/docs/api/latest/NotificationManager#instance-addInfo", "leftLabel": "Notification", "type": "method" }, { "name": "addSuccess", "text": null, "snippet": "addSuccess(${1:message}, ${2:options})", "description": "Add a success notification.", "descriptionMoreURL": "https://atom.io/docs/api/latest/NotificationManager#instance-addSuccess", "leftLabel": "Notification", "type": "method" }, { "name": "addWarning", "text": null, "snippet": "addWarning(${1:message}, ${2:options})", "description": "Add a warning notification.", "descriptionMoreURL": "https://atom.io/docs/api/latest/NotificationManager#instance-addWarning", "leftLabel": "Notification", "type": "method" }, { "name": "getNotifications", "text": "getNotifications()", "snippet": null, "description": "Get all the notifications.", "descriptionMoreURL": "https://atom.io/docs/api/latest/NotificationManager#instance-getNotifications", "leftLabel": "Array", "type": "method" }, { "name": "onDidAddNotification", "text": null, "snippet": "onDidAddNotification(${1:callback})", "description": "Invoke the given callback after a notification has been added.", "descriptionMoreURL": "https://atom.io/docs/api/latest/NotificationManager#instance-onDidAddNotification", "leftLabel": "Disposable", "type": "method" } ], "Package": [ { "name": "getBuildFailureOutput", "text": "getBuildFailureOutput()", "snippet": null, "description": "If a previous rebuild failed, get the contents of stderr.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Package#instance-getBuildFailureOutput", "leftLabel": "String", "type": "method" }, { "name": "isCompatible", "text": "isCompatible()", "snippet": null, "description": "Are all native modules depended on by this package correctly\ncompiled against the current version of Atom?", "descriptionMoreURL": "https://atom.io/docs/api/latest/Package#instance-isCompatible", "leftLabel": "Boolean", "type": "method" }, { "name": "onDidDeactivate", "text": null, "snippet": "onDidDeactivate(${1:callback})", "description": "Invoke the given callback when all packages have been activated.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Package#instance-onDidDeactivate", "leftLabel": "Disposable", "type": "method" }, { "name": "rebuild", "text": "rebuild()", "snippet": null, "description": "Rebuild native modules in this package's dependencies for the\ncurrent version of Atom.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Package#instance-rebuild", "leftLabel": "Promise", "type": "method" } ], "PackageManager": [ { "name": "disablePackage", "text": null, "snippet": "disablePackage(${1:name})", "description": "Disable the package with the given name.", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-disablePackage", "leftLabel": "Package", "type": "method" }, { "name": "enablePackage", "text": null, "snippet": "enablePackage(${1:name})", "description": "Enable the package with the given name.", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-enablePackage", "leftLabel": "Package", "type": "method" }, { "name": "getActivePackage", "text": null, "snippet": "getActivePackage(${1:name})", "description": "Get the active {Package} with the given name.", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-getActivePackage", "leftLabel": "Package", "type": "method" }, { "name": "getActivePackages", "text": "getActivePackages()", "snippet": null, "description": "Get an {Array} of all the active {Package}s.", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-getActivePackages", "type": "method" }, { "name": "getApmPath", "text": "getApmPath()", "snippet": null, "description": "Get the path to the apm command.", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-getApmPath", "type": "method" }, { "name": "getAvailablePackageMetadata", "text": "getAvailablePackageMetadata()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-getAvailablePackageMetadata", "leftLabel": "Array", "type": "method" }, { "name": "getAvailablePackageNames", "text": "getAvailablePackageNames()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-getAvailablePackageNames", "leftLabel": "Array", "type": "method" }, { "name": "getAvailablePackagePaths", "text": "getAvailablePackagePaths()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-getAvailablePackagePaths", "leftLabel": "Array", "type": "method" }, { "name": "getLoadedPackage", "text": null, "snippet": "getLoadedPackage(${1:name})", "description": "Get the loaded {Package} with the given name.", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-getLoadedPackage", "leftLabel": "Package", "type": "method" }, { "name": "getLoadedPackages", "text": "getLoadedPackages()", "snippet": null, "description": "Get an {Array} of all the loaded {Package}s", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-getLoadedPackages", "type": "method" }, { "name": "getPackageDirPaths", "text": "getPackageDirPaths()", "snippet": null, "description": "Get the paths being used to look for packages.", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-getPackageDirPaths", "leftLabel": "Array", "type": "method" }, { "name": "hasActivatedInitialPackages", "text": "hasActivatedInitialPackages()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-hasActivatedInitialPackages", "leftLabel": "Boolean", "type": "method" }, { "name": "hasLoadedInitialPackages", "text": "hasLoadedInitialPackages()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-hasLoadedInitialPackages", "leftLabel": "Boolean", "type": "method" }, { "name": "isBundledPackage", "text": null, "snippet": "isBundledPackage(${1:name})", "description": "Is the package with the given name bundled with Atom?", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-isBundledPackage", "leftLabel": "Boolean", "type": "method" }, { "name": "isPackageActive", "text": null, "snippet": "isPackageActive(${1:name})", "description": "Is the {Package} with the given name active?", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-isPackageActive", "leftLabel": "Boolean", "type": "method" }, { "name": "isPackageDisabled", "text": null, "snippet": "isPackageDisabled(${1:name})", "description": "Is the package with the given name disabled?", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-isPackageDisabled", "leftLabel": "Boolean", "type": "method" }, { "name": "isPackageLoaded", "text": null, "snippet": "isPackageLoaded(${1:name})", "description": "Is the package with the given name loaded?", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-isPackageLoaded", "leftLabel": "Boolean", "type": "method" }, { "name": "onDidActivateInitialPackages", "text": null, "snippet": "onDidActivateInitialPackages(${1:callback})", "description": "Invoke the given callback when all packages have been activated.", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-onDidActivateInitialPackages", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidActivatePackage", "text": null, "snippet": "onDidActivatePackage(${1:callback})", "description": "Invoke the given callback when a package is activated.", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-onDidActivatePackage", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDeactivatePackage", "text": null, "snippet": "onDidDeactivatePackage(${1:callback})", "description": "Invoke the given callback when a package is deactivated.", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-onDidDeactivatePackage", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidLoadInitialPackages", "text": null, "snippet": "onDidLoadInitialPackages(${1:callback})", "description": "Invoke the given callback when all packages have been loaded.", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-onDidLoadInitialPackages", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidLoadPackage", "text": null, "snippet": "onDidLoadPackage(${1:callback})", "description": "Invoke the given callback when a package is loaded.", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-onDidLoadPackage", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidUnloadPackage", "text": null, "snippet": "onDidUnloadPackage(${1:callback})", "description": "Invoke the given callback when a package is unloaded.", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-onDidUnloadPackage", "leftLabel": "Disposable", "type": "method" }, { "name": "resolvePackagePath", "text": null, "snippet": "resolvePackagePath(${1:name})", "description": "Resolve the given package name to a path on disk.", "descriptionMoreURL": "https://atom.io/docs/api/latest/PackageManager#instance-resolvePackagePath", "type": "method" } ], "Pane": [ { "name": "activate", "text": "activate()", "snippet": null, "description": "Makes this pane the *active* pane, causing it to gain focus.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-activate", "type": "method" }, { "name": "activateItem", "text": null, "snippet": "activateItem(${1:item}, ${2:options})", "description": "Make the given item *active*, causing it to be displayed by\nthe pane's view.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-activateItem", "type": "method" }, { "name": "activateItemAtIndex", "text": null, "snippet": "activateItemAtIndex(${1:index})", "description": "Activate the item at the given index.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-activateItemAtIndex", "type": "method" }, { "name": "activateItemForURI", "text": null, "snippet": "activateItemForURI(${1:uri})", "description": "Activate the first item that matches the given URI.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-activateItemForURI", "leftLabel": "Boolean", "type": "method" }, { "name": "activateNextItem", "text": "activateNextItem()", "snippet": null, "description": "Makes the next item active.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-activateNextItem", "type": "method" }, { "name": "activatePreviousItem", "text": "activatePreviousItem()", "snippet": null, "description": "Makes the previous item active.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-activatePreviousItem", "type": "method" }, { "name": "addItem", "text": null, "snippet": "addItem(${1:item}, ${2:options})", "description": "Add the given item to the pane.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-addItem", "leftLabel": null, "type": "method" }, { "name": "addItems", "text": null, "snippet": "addItems(${1:items}, ${2:index})", "description": "Add the given items to the pane.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-addItems", "leftLabel": "Array", "type": "method" }, { "name": "destroy", "text": "destroy()", "snippet": null, "description": "Close the pane and destroy all its items.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-destroy", "type": "method" }, { "name": "destroyActiveItem", "text": "destroyActiveItem()", "snippet": null, "description": "Destroy the active item and activate the next item.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-destroyActiveItem", "leftLabel": "Promise", "type": "method" }, { "name": "destroyInactiveItems", "text": "destroyInactiveItems()", "snippet": null, "description": "Destroy all items except for the active item.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-destroyInactiveItems", "type": "method" }, { "name": "destroyItem", "text": null, "snippet": "destroyItem(${1:item}, ${2:force})", "description": "Destroy the given item.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-destroyItem", "leftLabel": "Promise", "type": "method" }, { "name": "destroyItems", "text": "destroyItems()", "snippet": null, "description": "Destroy all items.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-destroyItems", "type": "method" }, { "name": "getActiveItem", "text": "getActiveItem()", "snippet": null, "description": "Get the active pane item in this pane.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-getActiveItem", "leftLabel": null, "type": "method" }, { "name": "getActiveItemIndex", "text": "getActiveItemIndex()", "snippet": null, "description": "Get the index of the active item.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-getActiveItemIndex", "leftLabel": "Number", "type": "method" }, { "name": "getItems", "text": "getItems()", "snippet": null, "description": "Get the items in this pane.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-getItems", "leftLabel": "Array", "type": "method" }, { "name": "isActive", "text": "isActive()", "snippet": null, "description": "Determine whether the pane is active.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-isActive", "leftLabel": "Boolean", "type": "method" }, { "name": "isDestroyed", "text": "isDestroyed()", "snippet": null, "description": "Determine whether this pane has been destroyed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-isDestroyed", "leftLabel": "Boolean", "type": "method" }, { "name": "itemAtIndex", "text": null, "snippet": "itemAtIndex(${1:index})", "description": "Return the item at the given index.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-itemAtIndex", "leftLabel": null, "type": "method" }, { "name": "itemForURI", "text": null, "snippet": "itemForURI(${1:uri})", "description": "Return the first item that matches the given URI or undefined if\nnone exists.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-itemForURI", "type": "method" }, { "name": "moveItem", "text": null, "snippet": "moveItem(${1:item}, ${2:index})", "description": "Move the given item to the given index.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-moveItem", "type": "method" }, { "name": "moveItemLeft", "text": "moveItemLeft()", "snippet": null, "description": "Move the active tab to the left", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-moveItemLeft", "type": "method" }, { "name": "moveItemRight", "text": "moveItemRight()", "snippet": null, "description": "Move the active tab to the right.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-moveItemRight", "type": "method" }, { "name": "moveItemToPane", "text": null, "snippet": "moveItemToPane(${1:item}, ${2:pane}, ${3:index})", "description": "Move the given item to the given index on another pane.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-moveItemToPane", "type": "method" }, { "name": "observeActive", "text": null, "snippet": "observeActive(${1:callback})", "description": "Invoke the given callback with the current and future values of the\n{::isActive} property.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-observeActive", "leftLabel": "Disposable", "type": "method" }, { "name": "observeActiveItem", "text": null, "snippet": "observeActiveItem(${1:callback})", "description": "Invoke the given callback with the current and future values of\n{::getActiveItem}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-observeActiveItem", "leftLabel": "Disposable", "type": "method" }, { "name": "observeFlexScale", "text": null, "snippet": "observeFlexScale(${1:callback})", "description": "Invoke the given callback with the current and future values of\n{::getFlexScale}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-observeFlexScale", "leftLabel": "Disposable", "type": "method" }, { "name": "observeItems", "text": null, "snippet": "observeItems(${1:callback})", "description": "Invoke the given callback with all current and future items.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-observeItems", "leftLabel": "Disposable", "type": "method" }, { "name": "onChooseLastMRUItem", "text": null, "snippet": "onChooseLastMRUItem(${1:callback})", "description": "Invoke the given callback when {::activatePreviousRecentlyUsedItem}\nhas been called, either initiating or continuing a reverse MRU traversal of\npane items.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-onChooseLastMRUItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onChooseNextMRUItem", "text": null, "snippet": "onChooseNextMRUItem(${1:callback})", "description": "Invoke the given callback when {::activateNextRecentlyUsedItem}\nhas been called, either initiating or continuing a forward MRU traversal of\npane items.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-onChooseNextMRUItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidActivate", "text": null, "snippet": "onDidActivate(${1:callback})", "description": "Invoke the given callback when the pane is activated.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-onDidActivate", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidAddItem", "text": null, "snippet": "onDidAddItem(${1:callback})", "description": "Invoke the given callback when an item is added to the pane.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-onDidAddItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeActive", "text": null, "snippet": "onDidChangeActive(${1:callback})", "description": "Invoke the given callback when the value of the {::isActive}\nproperty changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-onDidChangeActive", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeActiveItem", "text": null, "snippet": "onDidChangeActiveItem(${1:callback})", "description": "Invoke the given callback when the value of {::getActiveItem}\nchanges.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-onDidChangeActiveItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeFlexScale", "text": null, "snippet": "onDidChangeFlexScale(${1:callback})", "description": "Invoke the given callback when the pane resizes", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-onDidChangeFlexScale", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroy", "text": null, "snippet": "onDidDestroy(${1:callback})", "description": "Invoke the given callback when the pane is destroyed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-onDidDestroy", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidMoveItem", "text": null, "snippet": "onDidMoveItem(${1:callback})", "description": "Invoke the given callback when an item is moved within the pane.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-onDidMoveItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidRemoveItem", "text": null, "snippet": "onDidRemoveItem(${1:callback})", "description": "Invoke the given callback when an item is removed from the pane.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-onDidRemoveItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onDoneChoosingMRUItem", "text": null, "snippet": "onDoneChoosingMRUItem(${1:callback})", "description": "Invoke the given callback when {::moveActiveItemToTopOfStack}\nhas been called, terminating an MRU traversal of pane items and moving the\ncurrent active item to the top of the stack. Typically bound to a modifier\n(e.g. CTRL) key up event.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-onDoneChoosingMRUItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onWillDestroy", "text": null, "snippet": "onWillDestroy(${1:callback})", "description": "Invoke the given callback before the pane is destroyed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-onWillDestroy", "leftLabel": "Disposable", "type": "method" }, { "name": "onWillDestroyItem", "text": null, "snippet": "onWillDestroyItem(${1:callback})", "description": "Invoke the given callback before items are destroyed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-onWillDestroyItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onWillRemoveItem", "text": null, "snippet": "onWillRemoveItem(${1:callback})", "description": "Invoke the given callback before an item is removed from the pane.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-onWillRemoveItem", "type": "method" }, { "name": "saveActiveItem", "text": "saveActiveItem()", "snippet": null, "description": "Save the active item.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-saveActiveItem", "type": "method" }, { "name": "saveActiveItemAs", "text": null, "snippet": "saveActiveItemAs(${1:nextAction})", "description": "Prompt the user for a location and save the active item with the\npath they select.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-saveActiveItemAs", "leftLabel": "Promise", "type": "method" }, { "name": "saveItem", "text": null, "snippet": "saveItem(${1:item}, ${2:nextAction})", "description": "Save the given item.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-saveItem", "leftLabel": "Promise", "type": "method" }, { "name": "saveItemAs", "text": null, "snippet": "saveItemAs(${1:item}, ${2:nextAction})", "description": "Prompt the user for a location and save the active item with the\npath they select.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-saveItemAs", "type": "method" }, { "name": "saveItems", "text": "saveItems()", "snippet": null, "description": "Save all items.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-saveItems", "type": "method" }, { "name": "splitDown", "text": null, "snippet": "splitDown(${1:params})", "description": "Creates a new pane below the receiver.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-splitDown", "leftLabel": "Pane", "type": "method" }, { "name": "splitLeft", "text": null, "snippet": "splitLeft(${1:params})", "description": "Create a new pane to the left of this pane.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-splitLeft", "leftLabel": "Pane", "type": "method" }, { "name": "splitRight", "text": null, "snippet": "splitRight(${1:params})", "description": "Create a new pane to the right of this pane.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-splitRight", "leftLabel": "Pane", "type": "method" }, { "name": "splitUp", "text": null, "snippet": "splitUp(${1:params})", "description": "Creates a new pane above the receiver.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Pane#instance-splitUp", "leftLabel": "Pane", "type": "method" } ], "Panel": [ { "name": "destroy", "text": "destroy()", "snippet": null, "description": "Destroy and remove this panel from the UI.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Panel#instance-destroy", "type": "method" }, { "name": "getItem", "text": "getItem()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Panel#instance-getItem", "leftLabel": null, "type": "method" }, { "name": "getPriority", "text": "getPriority()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Panel#instance-getPriority", "leftLabel": "Number", "type": "method" }, { "name": "hide", "text": "hide()", "snippet": null, "description": "Hide this panel", "descriptionMoreURL": "https://atom.io/docs/api/latest/Panel#instance-hide", "type": "method" }, { "name": "isVisible", "text": "isVisible()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Panel#instance-isVisible", "leftLabel": "Boolean", "type": "method" }, { "name": "onDidChangeVisible", "text": null, "snippet": "onDidChangeVisible(${1:callback})", "description": "Invoke the given callback when the pane hidden or shown.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Panel#instance-onDidChangeVisible", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroy", "text": null, "snippet": "onDidDestroy(${1:callback})", "description": "Invoke the given callback when the pane is destroyed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Panel#instance-onDidDestroy", "leftLabel": "Disposable", "type": "method" }, { "name": "show", "text": "show()", "snippet": null, "description": "Show this panel", "descriptionMoreURL": "https://atom.io/docs/api/latest/Panel#instance-show", "type": "method" } ], "PathWatcher": [ { "name": "dispose", "text": "dispose()", "snippet": null, "description": "Unsubscribe all subscribers from filesystem events. Native resources will be release asynchronously,\nbut this watcher will stop broadcasting events immediately.", "descriptionMoreURL": "https://atom.io/docs/api/latest/PathWatcher#instance-dispose", "type": "method" }, { "name": "getStartPromise", "text": "getStartPromise()", "snippet": null, "description": "Return a {Promise} that will resolve when the underlying native watcher is ready to begin sending events.\nWhen testing filesystem watchers, it's important to await this promise before making filesystem changes that you\nintend to assert about because there will be a delay between the instantiation of the watcher and the activation\nof the underlying OS resources that feed it events.", "descriptionMoreURL": "https://atom.io/docs/api/latest/PathWatcher#instance-getStartPromise", "type": "method" }, { "name": "onDidError", "text": null, "snippet": "onDidError(${1:callback})", "description": "Invoke a {Function} when any errors related to this watcher are reported.", "descriptionMoreURL": "https://atom.io/docs/api/latest/PathWatcher#instance-onDidError", "leftLabel": "Disposable", "type": "method" } ], "Point": [ { "name": "column", "text": "column", "description": "A zero-indexed {Number} representing the column of the {Point}. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/Point#instance-column", "leftLabel": "Number", "type": "property" }, { "name": "row", "text": "row", "description": "A zero-indexed {Number} representing the row of the {Point}. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/Point#instance-row", "leftLabel": "Number", "type": "property" }, { "name": "compare", "text": null, "snippet": "compare(${1:other})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Point#instance-compare", "leftLabel": null, "type": "method" }, { "name": "constructor", "text": null, "snippet": "constructor(${1:row}, ${2:column})", "description": "Construct a {Point} object", "descriptionMoreURL": "https://atom.io/docs/api/latest/Point#instance-constructor", "type": "method" }, { "name": "copy", "text": "copy()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Point#instance-copy", "leftLabel": "Point", "type": "method" }, { "name": "freeze", "text": "freeze()", "snippet": null, "description": "Makes this point immutable and returns itself.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Point#instance-freeze", "leftLabel": "Point", "type": "method" }, { "name": "isEqual", "text": null, "snippet": "isEqual(${1:other})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Point#instance-isEqual", "leftLabel": "Boolean", "type": "method" }, { "name": "isGreaterThan", "text": null, "snippet": "isGreaterThan(${1:other})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Point#instance-isGreaterThan", "leftLabel": "Boolean", "type": "method" }, { "name": "isGreaterThanOrEqual", "text": null, "snippet": "isGreaterThanOrEqual(${1:other})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Point#instance-isGreaterThanOrEqual", "leftLabel": "Boolean", "type": "method" }, { "name": "isLessThan", "text": null, "snippet": "isLessThan(${1:other})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Point#instance-isLessThan", "leftLabel": "Boolean", "type": "method" }, { "name": "isLessThanOrEqual", "text": null, "snippet": "isLessThanOrEqual(${1:other})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Point#instance-isLessThanOrEqual", "leftLabel": "Boolean", "type": "method" }, { "name": "negate", "text": "negate()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Point#instance-negate", "leftLabel": "Point", "type": "method" }, { "name": "serialize", "text": "serialize()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Point#instance-serialize", "leftLabel": null, "type": "method" }, { "name": "toArray", "text": "toArray()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Point#instance-toArray", "leftLabel": null, "type": "method" }, { "name": "toString", "text": "toString()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Point#instance-toString", "leftLabel": null, "type": "method" }, { "name": "translate", "text": null, "snippet": "translate(${1:other})", "description": "Build and return a new point by adding the rows and columns of\nthe given point.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Point#instance-translate", "leftLabel": "Point", "type": "method" }, { "name": "traverse", "text": null, "snippet": "traverse(${1:other})", "description": "Build and return a new {Point} by traversing the rows and columns\nspecified by the given point.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Point#instance-traverse", "leftLabel": "Point", "type": "method" } ], "Project": [ { "name": "addPath", "text": null, "snippet": "addPath(${1:projectPath}, ${2:options})", "description": "Add a path to the project's list of root paths", "descriptionMoreURL": "https://atom.io/docs/api/latest/Project#instance-addPath", "type": "method" }, { "name": "contains", "text": null, "snippet": "contains(${1:pathToCheck})", "description": "Determines whether the given path (real or symbolic) is inside the\nproject's directory.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Project#instance-contains", "leftLabel": null, "type": "method" }, { "name": "getDirectories", "text": "getDirectories()", "snippet": null, "description": "Get an {Array} of {Directory}s associated with this project.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Project#instance-getDirectories", "type": "method" }, { "name": "getPaths", "text": "getPaths()", "snippet": null, "description": "Get an {Array} of {String}s containing the paths of the project's\ndirectories.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Project#instance-getPaths", "type": "method" }, { "name": "getRepositories", "text": "getRepositories()", "snippet": null, "description": "Get an {Array} of {GitRepository}s associated with the project's\ndirectories.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Project#instance-getRepositories", "type": "method" }, { "name": "getWatcherPromise", "text": null, "snippet": "getWatcherPromise(${1:projectPath})", "description": "Access a {Promise} that resolves when the filesystem watcher associated with a project\nroot directory is ready to begin receiving events.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Project#instance-getWatcherPromise", "leftLabel": "Promise", "type": "method" }, { "name": "observeBuffers", "text": null, "snippet": "observeBuffers(${1:callback})", "description": "Invoke the given callback with all current and future text\nbuffers in the project.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Project#instance-observeBuffers", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidAddBuffer", "text": null, "snippet": "onDidAddBuffer(${1:callback})", "description": "Invoke the given callback when a text buffer is added to the\nproject.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Project#instance-onDidAddBuffer", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeFiles", "text": null, "snippet": "onDidChangeFiles(${1:callback})", "description": "Invoke a callback when a filesystem change occurs within any open\nproject path.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Project#instance-onDidChangeFiles", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangePaths", "text": null, "snippet": "onDidChangePaths(${1:callback})", "description": "Invoke the given callback when the project paths change.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Project#instance-onDidChangePaths", "leftLabel": "Disposable", "type": "method" }, { "name": "relativizePath", "text": null, "snippet": "relativizePath(${1:fullPath})", "description": "Get the path to the project directory that contains the given path,\nand the relative path from that project directory to the given path.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Project#instance-relativizePath", "leftLabel": "Array", "type": "method" }, { "name": "removePath", "text": null, "snippet": "removePath(${1:projectPath})", "description": "remove a path from the project's list of root paths.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Project#instance-removePath", "type": "method" }, { "name": "repositoryForDirectory", "text": null, "snippet": "repositoryForDirectory(${1:directory})", "description": "Get the repository for a given directory asynchronously.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Project#instance-repositoryForDirectory", "leftLabel": "Promise", "type": "method" }, { "name": "setPaths", "text": null, "snippet": "setPaths(${1:projectPaths}, ${2:options})", "description": "Set the paths of the project's directories.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Project#instance-setPaths", "type": "method" } ], "Range": [ { "name": "end", "text": "end", "description": "A {Point} representing the end of the {Range}. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-end", "leftLabel": "Point", "type": "property" }, { "name": "start", "text": "start", "description": "A {Point} representing the start of the {Range}. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-start", "leftLabel": "Point", "type": "property" }, { "name": "compare", "text": null, "snippet": "compare(${1:otherRange})", "description": "Compare two Ranges", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-compare", "leftLabel": null, "type": "method" }, { "name": "constructor", "text": null, "snippet": "constructor(${1:pointA}, ${2:pointB})", "description": "Construct a {Range} object", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-constructor", "type": "method" }, { "name": "containsPoint", "text": null, "snippet": "containsPoint(${1:point}, ${2:exclusive})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-containsPoint", "leftLabel": "Boolean", "type": "method" }, { "name": "containsRange", "text": null, "snippet": "containsRange(${1:otherRange}, ${2:exclusive})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-containsRange", "leftLabel": "Boolean", "type": "method" }, { "name": "copy", "text": "copy()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-copy", "leftLabel": null, "type": "method" }, { "name": "coversSameRows", "text": null, "snippet": "coversSameRows(${1:otherRange})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-coversSameRows", "leftLabel": "Boolean", "type": "method" }, { "name": "freeze", "text": "freeze()", "snippet": null, "description": "Freezes the range and its start and end point so it becomes\nimmutable and returns itself.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-freeze", "leftLabel": "Range", "type": "method" }, { "name": "getRowCount", "text": "getRowCount()", "snippet": null, "description": "Get the number of rows in this range.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-getRowCount", "leftLabel": "Number", "type": "method" }, { "name": "getRows", "text": "getRows()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-getRows", "leftLabel": null, "type": "method" }, { "name": "intersectsRow", "text": null, "snippet": "intersectsRow(${1:row})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-intersectsRow", "leftLabel": "Boolean", "type": "method" }, { "name": "intersectsRowRange", "text": null, "snippet": "intersectsRowRange(${1:startRow}, ${2:endRow})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-intersectsRowRange", "leftLabel": "Boolean", "type": "method" }, { "name": "intersectsWith", "text": null, "snippet": "intersectsWith(${1:otherRange}, ${2:exclusive})", "description": "Determines whether this range intersects with the argument.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-intersectsWith", "leftLabel": "Boolean", "type": "method" }, { "name": "isEmpty", "text": "isEmpty()", "snippet": null, "description": "Is the start position of this range equal to the end position?", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-isEmpty", "leftLabel": "Boolean", "type": "method" }, { "name": "isEqual", "text": null, "snippet": "isEqual(${1:otherRange})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-isEqual", "leftLabel": "Boolean", "type": "method" }, { "name": "isSingleLine", "text": "isSingleLine()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-isSingleLine", "leftLabel": "Boolean", "type": "method" }, { "name": "negate", "text": "negate()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-negate", "leftLabel": null, "type": "method" }, { "name": "serialize", "text": "serialize()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-serialize", "leftLabel": null, "type": "method" }, { "name": "toString", "text": "toString()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-toString", "leftLabel": null, "type": "method" }, { "name": "translate", "text": null, "snippet": "translate(${1:startDelta}, ${2:endDelta})", "description": "Build and return a new range by translating this range's start and\nend points by the given delta(s).", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-translate", "leftLabel": "Range", "type": "method" }, { "name": "traverse", "text": null, "snippet": "traverse(${1:delta})", "description": "Build and return a new range by traversing this range's start and\nend points by the given delta.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-traverse", "leftLabel": "Range", "type": "method" }, { "name": "union", "text": null, "snippet": "union(${1:otherRange})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Range#instance-union", "leftLabel": null, "type": "method" } ], "ScopeDescriptor": [ { "name": "constructor", "text": null, "snippet": "constructor(${1:object})", "description": "Create a {ScopeDescriptor} object.", "descriptionMoreURL": "https://atom.io/docs/api/latest/ScopeDescriptor#instance-constructor", "type": "method" }, { "name": "getScopesArray", "text": "getScopesArray()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/ScopeDescriptor#instance-getScopesArray", "leftLabel": "Array", "type": "method" } ], "Selection": [ { "name": "addSelectionAbove", "text": "addSelectionAbove()", "snippet": null, "description": "Moves the selection up one row.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-addSelectionAbove", "type": "method" }, { "name": "addSelectionBelow", "text": "addSelectionBelow()", "snippet": null, "description": "Moves the selection down one row.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-addSelectionBelow", "type": "method" }, { "name": "autoIndentSelectedRows", "text": "autoIndentSelectedRows()", "snippet": null, "description": "Sets the indentation level of all selected rows to values suggested\nby the relevant grammars.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-autoIndentSelectedRows", "type": "method" }, { "name": "backspace", "text": "backspace()", "snippet": null, "description": "Removes the first character before the selection if the selection\nis empty otherwise it deletes the selection.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-backspace", "type": "method" }, { "name": "clear", "text": null, "snippet": "clear(${1:options})", "description": "Clears the selection, moving the marker to the head.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-clear", "type": "method" }, { "name": "compare", "text": null, "snippet": "compare(${1:otherSelection})", "description": "Compare this selection's buffer range to another selection's buffer\nrange.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-compare", "type": "method" }, { "name": "copy", "text": null, "snippet": "copy(${1:maintainClipboard}, ${2:fullLine})", "description": "Copies the current selection to the clipboard.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-copy", "type": "method" }, { "name": "cut", "text": null, "snippet": "cut(${1:maintainClipboard}, ${2:fullLine})", "description": "Copies the selection to the clipboard and then deletes it.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-cut", "type": "method" }, { "name": "cutToEndOfBufferLine", "text": "cutToEndOfBufferLine()", "snippet": null, "description": "Cuts the selection until the end of the buffer line.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-cutToEndOfBufferLine", "type": "method" }, { "name": "cutToEndOfLine", "text": "cutToEndOfLine()", "snippet": null, "description": "Cuts the selection until the end of the screen line.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-cutToEndOfLine", "type": "method" }, { "name": "delete", "text": "delete()", "snippet": null, "description": "Removes the selection or the next character after the start of the\nselection if the selection is empty.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-delete", "type": "method" }, { "name": "deleteLine", "text": "deleteLine()", "snippet": null, "description": "Removes the line at the beginning of the selection if the selection\nis empty unless the selection spans multiple lines in which case all lines\nare removed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-deleteLine", "type": "method" }, { "name": "deleteSelectedText", "text": "deleteSelectedText()", "snippet": null, "description": "Removes only the selected text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-deleteSelectedText", "type": "method" }, { "name": "deleteToBeginningOfLine", "text": "deleteToBeginningOfLine()", "snippet": null, "description": "Removes from the beginning of the line which the selection begins on\nall the way through to the end of the selection.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-deleteToBeginningOfLine", "type": "method" }, { "name": "deleteToBeginningOfSubword", "text": "deleteToBeginningOfSubword()", "snippet": null, "description": "Removes the selection or all characters from the start of the\nselection to the end of the current word if nothing is selected.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-deleteToBeginningOfSubword", "type": "method" }, { "name": "deleteToBeginningOfWord", "text": "deleteToBeginningOfWord()", "snippet": null, "description": "Removes from the start of the selection to the beginning of the\ncurrent word if the selection is empty otherwise it deletes the selection.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-deleteToBeginningOfWord", "type": "method" }, { "name": "deleteToEndOfLine", "text": "deleteToEndOfLine()", "snippet": null, "description": "If the selection is empty, removes all text from the cursor to the\nend of the line. If the cursor is already at the end of the line, it\nremoves the following newline. If the selection isn't empty, only deletes\nthe contents of the selection.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-deleteToEndOfLine", "type": "method" }, { "name": "deleteToEndOfSubword", "text": "deleteToEndOfSubword()", "snippet": null, "description": "Removes the selection or all characters from the start of the\nselection to the end of the current word if nothing is selected.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-deleteToEndOfSubword", "type": "method" }, { "name": "deleteToEndOfWord", "text": "deleteToEndOfWord()", "snippet": null, "description": "Removes the selection or all characters from the start of the\nselection to the end of the current word if nothing is selected.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-deleteToEndOfWord", "type": "method" }, { "name": "deleteToNextWordBoundary", "text": "deleteToNextWordBoundary()", "snippet": null, "description": "Removes the selection or, if nothing is selected, then all\ncharacters from the start of the selection up to the next word\nboundary.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-deleteToNextWordBoundary", "type": "method" }, { "name": "deleteToPreviousWordBoundary", "text": "deleteToPreviousWordBoundary()", "snippet": null, "description": "Removes the selection or, if nothing is selected, then all\ncharacters from the start of the selection back to the previous word\nboundary.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-deleteToPreviousWordBoundary", "type": "method" }, { "name": "expandOverLine", "text": "expandOverLine()", "snippet": null, "description": "Expands the newest selection to include the entire line on which\nthe cursor currently rests.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-expandOverLine", "type": "method" }, { "name": "expandOverWord", "text": "expandOverWord()", "snippet": null, "description": "Expands the newest selection to include the entire word on which\nthe cursors rests.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-expandOverWord", "type": "method" }, { "name": "fold", "text": "fold()", "snippet": null, "description": "Creates a fold containing the current selection.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-fold", "type": "method" }, { "name": "getBufferRange", "text": "getBufferRange()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-getBufferRange", "leftLabel": "Range", "type": "method" }, { "name": "getBufferRowRange", "text": "getBufferRowRange()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-getBufferRowRange", "leftLabel": null, "type": "method" }, { "name": "getScreenRange", "text": "getScreenRange()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-getScreenRange", "leftLabel": "Range", "type": "method" }, { "name": "getText", "text": "getText()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-getText", "leftLabel": null, "type": "method" }, { "name": "indentSelectedRows", "text": "indentSelectedRows()", "snippet": null, "description": "If the selection spans multiple rows, indent all of them.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-indentSelectedRows", "type": "method" }, { "name": "insertText", "text": null, "snippet": "insertText(${1:text}, ${2:options})", "description": "Replaces text at the current selection.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-insertText", "type": "method" }, { "name": "intersectsBufferRange", "text": null, "snippet": "intersectsBufferRange(${1:bufferRange})", "description": "Identifies if a selection intersects with a given buffer range.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-intersectsBufferRange", "leftLabel": "Boolean", "type": "method" }, { "name": "intersectsWith", "text": null, "snippet": "intersectsWith(${1:otherSelection})", "description": "Identifies if a selection intersects with another selection.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-intersectsWith", "leftLabel": "Boolean", "type": "method" }, { "name": "isEmpty", "text": "isEmpty()", "snippet": null, "description": "Determines if the selection contains anything.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-isEmpty", "type": "method" }, { "name": "isReversed", "text": "isReversed()", "snippet": null, "description": "Determines if the ending position of a marker is greater than the\nstarting position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-isReversed", "type": "method" }, { "name": "isSingleScreenLine", "text": "isSingleScreenLine()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-isSingleScreenLine", "leftLabel": null, "type": "method" }, { "name": "joinLines", "text": "joinLines()", "snippet": null, "description": "Joins the current line with the one below it. Lines will\nbe separated by a single space.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-joinLines", "type": "method" }, { "name": "merge", "text": null, "snippet": "merge(${1:otherSelection}, ${2:options})", "description": "Combines the given selection into this selection and then destroys\nthe given selection.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-merge", "type": "method" }, { "name": "onDidChangeRange", "text": null, "snippet": "onDidChangeRange(${1:callback})", "description": "Calls your `callback` when the selection was moved.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-onDidChangeRange", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroy", "text": null, "snippet": "onDidDestroy(${1:callback})", "description": "Calls your `callback` when the selection was destroyed", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-onDidDestroy", "leftLabel": "Disposable", "type": "method" }, { "name": "outdentSelectedRows", "text": "outdentSelectedRows()", "snippet": null, "description": "Removes one level of indent from the currently selected rows.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-outdentSelectedRows", "type": "method" }, { "name": "selectAll", "text": "selectAll()", "snippet": null, "description": "Selects all the text in the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectAll", "type": "method" }, { "name": "selectDown", "text": null, "snippet": "selectDown(${1:rowCount})", "description": "Selects all the text one position below the cursor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectDown", "type": "method" }, { "name": "selectLeft", "text": null, "snippet": "selectLeft(${1:columnCount})", "description": "Selects the text one position left of the cursor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectLeft", "type": "method" }, { "name": "selectLine", "text": null, "snippet": "selectLine(${1:row})", "description": "Selects an entire line in the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectLine", "type": "method" }, { "name": "selectRight", "text": null, "snippet": "selectRight(${1:columnCount})", "description": "Selects the text one position right of the cursor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectRight", "type": "method" }, { "name": "selectToBeginningOfLine", "text": "selectToBeginningOfLine()", "snippet": null, "description": "Selects all the text from the current cursor position to the\nbeginning of the line.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectToBeginningOfLine", "type": "method" }, { "name": "selectToBeginningOfNextParagraph", "text": "selectToBeginningOfNextParagraph()", "snippet": null, "description": "Selects all the text from the current cursor position to the\nbeginning of the next paragraph.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectToBeginningOfNextParagraph", "type": "method" }, { "name": "selectToBeginningOfNextWord", "text": "selectToBeginningOfNextWord()", "snippet": null, "description": "Selects all the text from the current cursor position to the\nbeginning of the next word.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectToBeginningOfNextWord", "type": "method" }, { "name": "selectToBeginningOfPreviousParagraph", "text": "selectToBeginningOfPreviousParagraph()", "snippet": null, "description": "Selects all the text from the current cursor position to the\nbeginning of the previous paragraph.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectToBeginningOfPreviousParagraph", "type": "method" }, { "name": "selectToBeginningOfWord", "text": "selectToBeginningOfWord()", "snippet": null, "description": "Selects all the text from the current cursor position to the\nbeginning of the word.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectToBeginningOfWord", "type": "method" }, { "name": "selectToBottom", "text": "selectToBottom()", "snippet": null, "description": "Selects all the text from the current cursor position to the bottom\nof the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectToBottom", "type": "method" }, { "name": "selectToBufferPosition", "text": null, "snippet": "selectToBufferPosition(${1:position})", "description": "Selects the text from the current cursor position to a given buffer\nposition.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectToBufferPosition", "type": "method" }, { "name": "selectToEndOfBufferLine", "text": "selectToEndOfBufferLine()", "snippet": null, "description": "Selects all the text from the current cursor position to the end of\nthe buffer line.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectToEndOfBufferLine", "type": "method" }, { "name": "selectToEndOfLine", "text": "selectToEndOfLine()", "snippet": null, "description": "Selects all the text from the current cursor position to the end of\nthe screen line.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectToEndOfLine", "type": "method" }, { "name": "selectToEndOfWord", "text": "selectToEndOfWord()", "snippet": null, "description": "Selects all the text from the current cursor position to the end of\nthe word.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectToEndOfWord", "type": "method" }, { "name": "selectToFirstCharacterOfLine", "text": "selectToFirstCharacterOfLine()", "snippet": null, "description": "Selects all the text from the current cursor position to the first\ncharacter of the line.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectToFirstCharacterOfLine", "type": "method" }, { "name": "selectToNextSubwordBoundary", "text": "selectToNextSubwordBoundary()", "snippet": null, "description": "Selects text to the next subword boundary.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectToNextSubwordBoundary", "type": "method" }, { "name": "selectToNextWordBoundary", "text": "selectToNextWordBoundary()", "snippet": null, "description": "Selects text to the next word boundary.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectToNextWordBoundary", "type": "method" }, { "name": "selectToPreviousSubwordBoundary", "text": "selectToPreviousSubwordBoundary()", "snippet": null, "description": "Selects text to the previous subword boundary.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectToPreviousSubwordBoundary", "type": "method" }, { "name": "selectToPreviousWordBoundary", "text": "selectToPreviousWordBoundary()", "snippet": null, "description": "Selects text to the previous word boundary.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectToPreviousWordBoundary", "type": "method" }, { "name": "selectToScreenPosition", "text": null, "snippet": "selectToScreenPosition(${1:position})", "description": "Selects the text from the current cursor position to a given screen\nposition.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectToScreenPosition", "type": "method" }, { "name": "selectToTop", "text": "selectToTop()", "snippet": null, "description": "Selects all the text from the current cursor position to the top of\nthe buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectToTop", "type": "method" }, { "name": "selectUp", "text": null, "snippet": "selectUp(${1:rowCount})", "description": "Selects all the text one position above the cursor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectUp", "type": "method" }, { "name": "selectWord", "text": "selectWord()", "snippet": null, "description": "Modifies the selection to encompass the current word.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-selectWord", "leftLabel": "Range", "type": "method" }, { "name": "setBufferRange", "text": null, "snippet": "setBufferRange(${1:bufferRange}, ${2:options})", "description": "Modifies the buffer {Range} for the selection.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-setBufferRange", "type": "method" }, { "name": "setScreenRange", "text": null, "snippet": "setScreenRange(${1:screenRange}, ${2:options})", "description": "Modifies the screen range for the selection.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-setScreenRange", "type": "method" }, { "name": "toggleLineComments", "text": "toggleLineComments()", "snippet": null, "description": "Wraps the selected lines in comments if they aren't currently part\nof a comment.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Selection#instance-toggleLineComments", "type": "method" } ], "StyleManager": [ { "name": "getStyleElements", "text": "getStyleElements()", "snippet": null, "description": "Get all loaded style elements.", "descriptionMoreURL": "https://atom.io/docs/api/latest/StyleManager#instance-getStyleElements", "type": "method" }, { "name": "getUserStyleSheetPath", "text": "getUserStyleSheetPath()", "snippet": null, "description": "Get the path of the user style sheet in `~/.atom`.", "descriptionMoreURL": "https://atom.io/docs/api/latest/StyleManager#instance-getUserStyleSheetPath", "leftLabel": "String", "type": "method" }, { "name": "observeStyleElements", "text": null, "snippet": "observeStyleElements(${1:callback})", "description": "Invoke `callback` for all current and future style elements.", "descriptionMoreURL": "https://atom.io/docs/api/latest/StyleManager#instance-observeStyleElements", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidAddStyleElement", "text": null, "snippet": "onDidAddStyleElement(${1:callback})", "description": "Invoke `callback` when a style element is added.", "descriptionMoreURL": "https://atom.io/docs/api/latest/StyleManager#instance-onDidAddStyleElement", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidRemoveStyleElement", "text": null, "snippet": "onDidRemoveStyleElement(${1:callback})", "description": "Invoke `callback` when a style element is removed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/StyleManager#instance-onDidRemoveStyleElement", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidUpdateStyleElement", "text": null, "snippet": "onDidUpdateStyleElement(${1:callback})", "description": "Invoke `callback` when an existing style element is updated.", "descriptionMoreURL": "https://atom.io/docs/api/latest/StyleManager#instance-onDidUpdateStyleElement", "leftLabel": "Disposable", "type": "method" } ], "Task": [ { "name": "cancel", "text": "cancel()", "snippet": null, "description": "Cancel the running task and emit an event if it was canceled.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Task#instance-cancel", "leftLabel": "Boolean", "type": "method" }, { "name": "constructor", "text": null, "snippet": "constructor(${1:taskPath})", "description": "Creates a task. You should probably use {.once}", "descriptionMoreURL": "https://atom.io/docs/api/latest/Task#instance-constructor", "type": "method" }, { "name": "on", "text": null, "snippet": "on(${1:eventName}, ${2:callback})", "description": "Call a function when an event is emitted by the child process", "descriptionMoreURL": "https://atom.io/docs/api/latest/Task#instance-on", "leftLabel": "Disposable", "type": "method" }, { "name": "once", "text": null, "snippet": "once(${1:taskPath}, ${2:args})", "description": "A helper method to easily launch and run a task once.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Task#instance-once", "leftLabel": "Task", "type": "method" }, { "name": "send", "text": null, "snippet": "send(${1:message})", "description": "Send message to the task.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Task#instance-send", "type": "method" }, { "name": "start", "text": null, "snippet": "start(${1:args}, ${2:callback})", "description": "Starts the task.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Task#instance-start", "type": "method" }, { "name": "terminate", "text": "terminate()", "snippet": null, "description": "Forcefully stop the running task.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Task#instance-terminate", "type": "method" } ], "TextBuffer": [ { "name": "addMarkerLayer", "text": null, "snippet": "addMarkerLayer(${1:options})", "description": "Create a layer to contain a set of related markers.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-addMarkerLayer", "leftLabel": "MarkerLayer", "type": "method" }, { "name": "append", "text": null, "snippet": "append(${1:text}, ${2:options})", "description": "Append text to the end of the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-append", "leftLabel": "Range", "type": "method" }, { "name": "backwardsScan", "text": null, "snippet": "backwardsScan(${1:regex}, ${2:options}, ${3:iterator})", "description": "Scan regular expression matches in the entire buffer in reverse\norder, calling the given iterator function on each match.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-backwardsScan", "type": "method" }, { "name": "backwardsScanInRange", "text": null, "snippet": "backwardsScanInRange(${1:regex}, ${2:range}, ${3:options}, ${4:iterator})", "description": "Scan regular expression matches in a given range in reverse order,\ncalling the given iterator function on each match.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-backwardsScanInRange", "type": "method" }, { "name": "characterIndexForPosition", "text": null, "snippet": "characterIndexForPosition(${1:position})", "description": "Convert a position in the buffer in row/column coordinates to an\nabsolute character offset, inclusive of line ending characters.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-characterIndexForPosition", "leftLabel": "Number", "type": "method" }, { "name": "clearUndoStack", "text": "clearUndoStack()", "snippet": null, "description": "Clear the undo stack. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-clearUndoStack", "type": "method" }, { "name": "clipPosition", "text": null, "snippet": "clipPosition(${1:position})", "description": "Clip the given point so it is at a valid position in the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-clipPosition", "leftLabel": "Point", "type": "method" }, { "name": "clipRange", "text": null, "snippet": "clipRange(${1:range})", "description": "Clip the given range so it starts and ends at valid positions.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-clipRange", "leftLabel": "Range", "type": "method" }, { "name": "constructor", "text": null, "snippet": "constructor(${1:params})", "description": "Create a new buffer with the given params.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-constructor", "type": "method" }, { "name": "createCheckpoint", "text": "createCheckpoint()", "snippet": null, "description": "Create a pointer to the current state of the buffer for use\nwith {::revertToCheckpoint} and {::groupChangesSinceCheckpoint}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-createCheckpoint", "leftLabel": null, "type": "method" }, { "name": "delete", "text": null, "snippet": "delete(${1:range})", "description": "Delete the text in the given range.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-delete", "leftLabel": "Range", "type": "method" }, { "name": "deleteRow", "text": null, "snippet": "deleteRow(${1:row})", "description": "Delete the line associated with a specified row.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-deleteRow", "leftLabel": "Range", "type": "method" }, { "name": "deleteRows", "text": null, "snippet": "deleteRows(${1:startRow}, ${2:endRow})", "description": "Delete the lines associated with the specified row range.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-deleteRows", "leftLabel": "Range", "type": "method" }, { "name": "findMarkers", "text": null, "snippet": "findMarkers(${1:params})", "description": "Find markers conforming to the given parameters in the default\nmarker layer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-findMarkers", "leftLabel": "Array", "type": "method" }, { "name": "getChangesSinceCheckpoint", "text": "getChangesSinceCheckpoint()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getChangesSinceCheckpoint", "leftLabel": null, "type": "method" }, { "name": "getDefaultMarkerLayer", "text": "getDefaultMarkerLayer()", "snippet": null, "description": "Get the default {MarkerLayer}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getDefaultMarkerLayer", "leftLabel": "MarkerLayer", "type": "method" }, { "name": "getEncoding", "text": "getEncoding()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getEncoding", "leftLabel": "String", "type": "method" }, { "name": "getEndPosition", "text": "getEndPosition()", "snippet": null, "description": "Get the maximal position in the buffer, where new text would be\nappended.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getEndPosition", "leftLabel": "Point", "type": "method" }, { "name": "getFirstPosition", "text": "getFirstPosition()", "snippet": null, "description": "Get the first position in the buffer, which is always `[0, 0]`.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getFirstPosition", "leftLabel": "Point", "type": "method" }, { "name": "getLastLine", "text": "getLastLine()", "snippet": null, "description": "Get the text of the last line of the buffer, without its line\nending.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getLastLine", "leftLabel": "String", "type": "method" }, { "name": "getLastRow", "text": "getLastRow()", "snippet": null, "description": "Get the last 0-indexed row in the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getLastRow", "leftLabel": "Number", "type": "method" }, { "name": "getLineCount", "text": "getLineCount()", "snippet": null, "description": "Get the number of lines in the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getLineCount", "leftLabel": "Number", "type": "method" }, { "name": "getLines", "text": "getLines()", "snippet": null, "description": "Get the text of all lines in the buffer, without their line endings.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getLines", "leftLabel": "Array", "type": "method" }, { "name": "getMarker", "text": null, "snippet": "getMarker(${1:id})", "description": "Get an existing marker by its id from the default marker layer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getMarker", "leftLabel": "Marker", "type": "method" }, { "name": "getMarkerCount", "text": "getMarkerCount()", "snippet": null, "description": "Get the number of markers in the default marker layer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getMarkerCount", "leftLabel": "Number", "type": "method" }, { "name": "getMarkerLayer", "text": null, "snippet": "getMarkerLayer(${1:id})", "description": "Get a {MarkerLayer} by id.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getMarkerLayer", "leftLabel": "MarkerLayer", "type": "method" }, { "name": "getMarkers", "text": "getMarkers()", "snippet": null, "description": "Get all existing markers on the default marker layer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getMarkers", "leftLabel": "Array", "type": "method" }, { "name": "getMaxCharacterIndex", "text": "getMaxCharacterIndex()", "snippet": null, "description": "Get the length of the buffer in characters.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getMaxCharacterIndex", "leftLabel": "Number", "type": "method" }, { "name": "getPath", "text": "getPath()", "snippet": null, "description": "Get the path of the associated file.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getPath", "leftLabel": "String", "type": "method" }, { "name": "getRange", "text": "getRange()", "snippet": null, "description": "Get the range spanning from `[0, 0]` to {::getEndPosition}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getRange", "leftLabel": "Range", "type": "method" }, { "name": "getStoppedChangingDelay", "text": "getStoppedChangingDelay()", "snippet": null, "description": "Get the number of milliseconds that will elapse without a change\nbefore {::onDidStopChanging} observers are invoked following a change.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getStoppedChangingDelay", "leftLabel": "Number", "type": "method" }, { "name": "getText", "text": "getText()", "snippet": null, "description": "Get the entire text of the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getText", "leftLabel": "String", "type": "method" }, { "name": "getTextInRange", "text": null, "snippet": "getTextInRange(${1:range})", "description": "Get the text in a range.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getTextInRange", "leftLabel": "String", "type": "method" }, { "name": "getUri", "text": "getUri()", "snippet": null, "description": "Get the path of the associated file.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-getUri", "leftLabel": "String", "type": "method" }, { "name": "groupChangesSinceCheckpoint", "text": "groupChangesSinceCheckpoint()", "snippet": null, "description": "Group all changes since the given checkpoint into a single\ntransaction for purposes of undo/redo.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-groupChangesSinceCheckpoint", "leftLabel": "Boolean", "type": "method" }, { "name": "insert", "text": null, "snippet": "insert(${1:position}, ${2:text}, ${3:options})", "description": "Insert text at the given position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-insert", "leftLabel": "Range", "type": "method" }, { "name": "isEmpty", "text": "isEmpty()", "snippet": null, "description": "Determine whether the buffer is empty.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-isEmpty", "leftLabel": "Boolean", "type": "method" }, { "name": "isInConflict", "text": "isInConflict()", "snippet": null, "description": "Determine if the in-memory contents of the buffer conflict with the\non-disk contents of its associated file.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-isInConflict", "leftLabel": "Boolean", "type": "method" }, { "name": "isModified", "text": "isModified()", "snippet": null, "description": "Determine if the in-memory contents of the buffer differ from its\ncontents on disk.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-isModified", "leftLabel": "Boolean", "type": "method" }, { "name": "isRowBlank", "text": null, "snippet": "isRowBlank(${1:row})", "description": "Determine if the given row contains only whitespace.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-isRowBlank", "leftLabel": "Boolean", "type": "method" }, { "name": "lineEndingForRow", "text": null, "snippet": "lineEndingForRow(${1:row})", "description": "Get the line ending for the given 0-indexed row.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-lineEndingForRow", "leftLabel": "String", "type": "method" }, { "name": "lineForRow", "text": null, "snippet": "lineForRow(${1:row})", "description": "Get the text of the line at the given row, without its line ending.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-lineForRow", "leftLabel": "String", "type": "method" }, { "name": "lineLengthForRow", "text": null, "snippet": "lineLengthForRow(${1:row})", "description": "Get the length of the line for the given 0-indexed row, without its\nline ending.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-lineLengthForRow", "leftLabel": "Number", "type": "method" }, { "name": "load", "text": null, "snippet": "load(${1:source}, ${2:params})", "description": "Create a new buffer backed by the given file path.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-load", "leftLabel": "Promise", "type": "method" }, { "name": "loadSync", "text": null, "snippet": "loadSync(${1:filePath}, ${2:params})", "description": "Create a new buffer backed by the given file path. For better\nperformance, use {TextBuffer.load} instead.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-loadSync", "leftLabel": "TextBuffer", "type": "method" }, { "name": "markPosition", "text": null, "snippet": "markPosition(${1:position}, ${2:options})", "description": "Create a marker at the given position with no tail in the default\nmarker layer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-markPosition", "leftLabel": "Marker", "type": "method" }, { "name": "markRange", "text": null, "snippet": "markRange(${1:range}, ${2:properties})", "description": "Create a marker with the given range in the default marker layer.\nThis marker will maintain its logical location as the buffer is changed, so\nif you mark a particular word, the marker will remain over that word even if\nthe word's location in the buffer changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-markRange", "leftLabel": "Marker", "type": "method" }, { "name": "nextNonBlankRow", "text": null, "snippet": "nextNonBlankRow(${1:startRow})", "description": "Given a row, find the next row that's not blank.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-nextNonBlankRow", "leftLabel": "Number", "type": "method" }, { "name": "onDidChange", "text": null, "snippet": "onDidChange(${1:callback})", "description": "Invoke the given callback synchronously when a transaction finishes\nwith a list of all the changes in the transaction.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-onDidChange", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeEncoding", "text": null, "snippet": "onDidChangeEncoding(${1:callback})", "description": "Invoke the given callback when the value of {::getEncoding} changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-onDidChangeEncoding", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeModified", "text": null, "snippet": "onDidChangeModified(${1:callback})", "description": "Invoke the given callback if the value of {::isModified} changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-onDidChangeModified", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangePath", "text": null, "snippet": "onDidChangePath(${1:callback})", "description": "Invoke the given callback when the value of {::getPath} changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-onDidChangePath", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeText", "text": "onDidChangeText()", "snippet": null, "description": "This is now identical to {onDidChange}. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-onDidChangeText", "type": "method" }, { "name": "onDidConflict", "text": null, "snippet": "onDidConflict(${1:callback})", "description": "Invoke the given callback when the in-memory contents of the\nbuffer become in conflict with the contents of the file on disk.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-onDidConflict", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidCreateMarker", "text": null, "snippet": "onDidCreateMarker(${1:callback})", "description": "Invoke the given callback when a marker is created.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-onDidCreateMarker", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDelete", "text": null, "snippet": "onDidDelete(${1:callback})", "description": "Invoke the given callback after the file backing the buffer is\ndeleted.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-onDidDelete", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroy", "text": null, "snippet": "onDidDestroy(${1:callback})", "description": "Invoke the given callback when the buffer is destroyed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-onDidDestroy", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidReload", "text": null, "snippet": "onDidReload(${1:callback})", "description": "Invoke the given callback after the buffer is reloaded from the\ncontents of its file on disk.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-onDidReload", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidSave", "text": null, "snippet": "onDidSave(${1:callback})", "description": "Invoke the given callback after the buffer is saved to disk.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-onDidSave", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidStopChanging", "text": null, "snippet": "onDidStopChanging(${1:callback})", "description": "Invoke the given callback asynchronously following one or more\nchanges after {::getStoppedChangingDelay} milliseconds elapse without an\nadditional change.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-onDidStopChanging", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidUpdateMarkers", "text": null, "snippet": "onDidUpdateMarkers(${1:callback})", "description": "Invoke the given callback when all marker `::onDidChange`\nobservers have been notified following a change to the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-onDidUpdateMarkers", "leftLabel": "Disposable", "type": "method" }, { "name": "onWillChange", "text": null, "snippet": "onWillChange(${1:callback})", "description": "Invoke the given callback synchronously _before_ the content of the\nbuffer changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-onWillChange", "leftLabel": "Disposable", "type": "method" }, { "name": "onWillReload", "text": null, "snippet": "onWillReload(${1:callback})", "description": "Invoke the given callback before the buffer is reloaded from the\ncontents of its file on disk.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-onWillReload", "leftLabel": "Disposable", "type": "method" }, { "name": "onWillSave", "text": null, "snippet": "onWillSave(${1:callback})", "description": "Invoke the given callback before the buffer is saved to disk.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-onWillSave", "leftLabel": "Disposable", "type": "method" }, { "name": "onWillThrowWatchError", "text": null, "snippet": "onWillThrowWatchError(${1:callback})", "description": "Invoke the given callback when there is an error in watching the\nfile.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-onWillThrowWatchError", "leftLabel": "Disposable", "type": "method" }, { "name": "positionForCharacterIndex", "text": null, "snippet": "positionForCharacterIndex(${1:offset})", "description": "Convert an absolute character offset, inclusive of newlines, to a\nposition in the buffer in row/column coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-positionForCharacterIndex", "leftLabel": "Point", "type": "method" }, { "name": "previousNonBlankRow", "text": null, "snippet": "previousNonBlankRow(${1:startRow})", "description": "Given a row, find the first preceding row that's not blank.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-previousNonBlankRow", "leftLabel": "Number", "type": "method" }, { "name": "rangeForRow", "text": null, "snippet": "rangeForRow(${1:row}, ${2:includeNewline})", "description": "Get the range for the given row", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-rangeForRow", "leftLabel": "Range", "type": "method" }, { "name": "redo", "text": "redo()", "snippet": null, "description": "Redo the last operation ", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-redo", "type": "method" }, { "name": "reload", "text": "reload()", "snippet": null, "description": "Reload the file's content from disk.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-reload", "leftLabel": "Promise", "type": "method" }, { "name": "replace", "text": null, "snippet": "replace(${1:regex}, ${2:replacementText})", "description": "Replace all regular expression matches in the entire buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-replace", "leftLabel": "Number", "type": "method" }, { "name": "revertToCheckpoint", "text": "revertToCheckpoint()", "snippet": null, "description": "Revert the buffer to the state it was in when the given\ncheckpoint was created.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-revertToCheckpoint", "leftLabel": "Boolean", "type": "method" }, { "name": "save", "text": "save()", "snippet": null, "description": "Save the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-save", "leftLabel": "Promise", "type": "method" }, { "name": "saveAs", "text": null, "snippet": "saveAs(${1:filePath})", "description": "Save the buffer at a specific path.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-saveAs", "leftLabel": "Promise", "type": "method" }, { "name": "scan", "text": null, "snippet": "scan(${1:regex}, ${2:options}, ${3:iterator})", "description": "Scan regular expression matches in the entire buffer, calling the\ngiven iterator function on each match.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-scan", "type": "method" }, { "name": "scanInRange", "text": null, "snippet": "scanInRange(${1:regex}, ${2:range}, ${3:options}, ${4:callback})", "description": "Scan regular expression matches in a given range , calling the given\niterator function on each match.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-scanInRange", "type": "method" }, { "name": "setEncoding", "text": null, "snippet": "setEncoding(${1:encoding})", "description": "Sets the character set encoding for this buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-setEncoding", "type": "method" }, { "name": "setPath", "text": null, "snippet": "setPath(${1:filePath})", "description": "Set the path for the buffer's associated file.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-setPath", "type": "method" }, { "name": "setText", "text": null, "snippet": "setText(${1:text})", "description": "Replace the entire contents of the buffer with the given text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-setText", "leftLabel": "Range", "type": "method" }, { "name": "setTextInRange", "text": null, "snippet": "setTextInRange(${1:range}, ${2:text}, ${3:options})", "description": "Set the text in the given range.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-setTextInRange", "leftLabel": "Range", "type": "method" }, { "name": "setTextViaDiff", "text": null, "snippet": "setTextViaDiff(${1:text})", "description": "Replace the current buffer contents by applying a diff based on the\ngiven text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-setTextViaDiff", "type": "method" }, { "name": "transact", "text": null, "snippet": "transact(${1:groupingInterval}, ${2:fn})", "description": "Batch multiple operations as a single undo/redo step.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-transact", "type": "method" }, { "name": "undo", "text": "undo()", "snippet": null, "description": "Undo the last operation. If a transaction is in progress, aborts it. ", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextBuffer#instance-undo", "type": "method" } ], "TextEditor": [ { "name": "abortTransaction", "text": "abortTransaction()", "snippet": null, "description": "Abort an open transaction, undoing any operations performed so far\nwithin the transaction.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-abortTransaction", "type": "method" }, { "name": "addCursorAtBufferPosition", "text": null, "snippet": "addCursorAtBufferPosition(${1:bufferPosition})", "description": "Add a cursor at the given position in buffer coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-addCursorAtBufferPosition", "leftLabel": "Cursor", "type": "method" }, { "name": "addCursorAtScreenPosition", "text": null, "snippet": "addCursorAtScreenPosition(${1:screenPosition})", "description": "Add a cursor at the position in screen coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-addCursorAtScreenPosition", "leftLabel": "Cursor", "type": "method" }, { "name": "addGutter", "text": null, "snippet": "addGutter(${1:options})", "description": "Add a custom {Gutter}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-addGutter", "leftLabel": "Gutter", "type": "method" }, { "name": "addMarkerLayer", "text": null, "snippet": "addMarkerLayer(${1:options})", "description": "Create a marker layer to group related markers.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-addMarkerLayer", "leftLabel": "DisplayMarkerLayer", "type": "method" }, { "name": "addSelectionForBufferRange", "text": null, "snippet": "addSelectionForBufferRange(${1:bufferRange}, ${2:options})", "description": "Add a selection for the given range in buffer coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-addSelectionForBufferRange", "leftLabel": "Selection", "type": "method" }, { "name": "addSelectionForScreenRange", "text": null, "snippet": "addSelectionForScreenRange(${1:screenRange}, ${2:options})", "description": "Add a selection for the given range in screen coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-addSelectionForScreenRange", "type": "method" }, { "name": "autoIndentSelectedRows", "text": "autoIndentSelectedRows()", "snippet": null, "description": "Indent rows intersecting selections based on the grammar's suggested\nindent level.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-autoIndentSelectedRows", "type": "method" }, { "name": "backspace", "text": "backspace()", "snippet": null, "description": "For each selection, if the selection is empty, delete the character\npreceding the cursor. Otherwise delete the selected text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-backspace", "type": "method" }, { "name": "backwardsScanInBufferRange", "text": null, "snippet": "backwardsScanInBufferRange(${1:regex}, ${2:range}, ${3:iterator})", "description": "Scan regular expression matches in a given range in reverse order,\ncalling the given iterator function on each match.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-backwardsScanInBufferRange", "type": "method" }, { "name": "bufferPositionForScreenPosition", "text": null, "snippet": "bufferPositionForScreenPosition(${1:bufferPosition}, ${2:options})", "description": "Convert a position in screen-coordinates to buffer-coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-bufferPositionForScreenPosition", "leftLabel": "Point", "type": "method" }, { "name": "bufferRangeForScopeAtCursor", "text": null, "snippet": "bufferRangeForScopeAtCursor(${1:scopeSelector})", "description": "Get the range in buffer coordinates of all tokens surrounding the\ncursor that match the given scope selector.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-bufferRangeForScopeAtCursor", "leftLabel": "Range", "type": "method" }, { "name": "bufferRangeForScreenRange", "text": null, "snippet": "bufferRangeForScreenRange(${1:screenRange})", "description": "Convert a range in screen-coordinates to buffer-coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-bufferRangeForScreenRange", "leftLabel": "Range", "type": "method" }, { "name": "clipBufferPosition", "text": null, "snippet": "clipBufferPosition(${1:bufferPosition})", "description": "Clip the given {Point} to a valid position in the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-clipBufferPosition", "leftLabel": "Point", "type": "method" }, { "name": "clipBufferRange", "text": null, "snippet": "clipBufferRange(${1:range})", "description": "Clip the start and end of the given range to valid positions in the\nbuffer. See {::clipBufferPosition} for more information.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-clipBufferRange", "leftLabel": "Range", "type": "method" }, { "name": "clipScreenPosition", "text": null, "snippet": "clipScreenPosition(${1:screenPosition}, ${2:options})", "description": "Clip the given {Point} to a valid position on screen.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-clipScreenPosition", "leftLabel": "Point", "type": "method" }, { "name": "clipScreenRange", "text": null, "snippet": "clipScreenRange(${1:range}, ${2:options})", "description": "Clip the start and end of the given range to valid positions on screen.\nSee {::clipScreenPosition} for more information.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-clipScreenRange", "leftLabel": "Range", "type": "method" }, { "name": "copySelectedText", "text": "copySelectedText()", "snippet": null, "description": "For each selection, copy the selected text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-copySelectedText", "type": "method" }, { "name": "createCheckpoint", "text": "createCheckpoint()", "snippet": null, "description": "Create a pointer to the current state of the buffer for use\nwith {::revertToCheckpoint} and {::groupChangesSinceCheckpoint}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-createCheckpoint", "leftLabel": null, "type": "method" }, { "name": "cutSelectedText", "text": "cutSelectedText()", "snippet": null, "description": "For each selection, cut the selected text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-cutSelectedText", "type": "method" }, { "name": "cutToEndOfBufferLine", "text": "cutToEndOfBufferLine()", "snippet": null, "description": "For each selection, if the selection is empty, cut all characters\nof the containing buffer line following the cursor. Otherwise cut the\nselected text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-cutToEndOfBufferLine", "type": "method" }, { "name": "cutToEndOfLine", "text": "cutToEndOfLine()", "snippet": null, "description": "For each selection, if the selection is empty, cut all characters\nof the containing screen line following the cursor. Otherwise cut the selected\ntext.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-cutToEndOfLine", "type": "method" }, { "name": "decorateMarker", "text": null, "snippet": "decorateMarker(${1:marker}, ${2:decorationParams})", "description": "Add a decoration that tracks a {DisplayMarker}. When the\nmarker moves, is invalidated, or is destroyed, the decoration will be\nupdated to reflect the marker's state.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-decorateMarker", "leftLabel": "Decoration", "type": "method" }, { "name": "decorateMarkerLayer", "text": null, "snippet": "decorateMarkerLayer(${1:markerLayer}, ${2:decorationParams})", "description": "Add a decoration to every marker in the given marker layer. Can\nbe used to decorate a large number of markers without having to create and\nmanage many individual decorations.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-decorateMarkerLayer", "leftLabel": "LayerDecoration", "type": "method" }, { "name": "delete", "text": "delete()", "snippet": null, "description": "For each selection, if the selection is empty, delete the character\nfollowing the cursor. Otherwise delete the selected text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-delete", "type": "method" }, { "name": "deleteLine", "text": "deleteLine()", "snippet": null, "description": "Delete all lines intersecting selections.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-deleteLine", "type": "method" }, { "name": "deleteToBeginningOfLine", "text": "deleteToBeginningOfLine()", "snippet": null, "description": "For each selection, if the selection is empty, delete all characters\nof the containing line that precede the cursor. Otherwise delete the\nselected text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-deleteToBeginningOfLine", "type": "method" }, { "name": "deleteToBeginningOfSubword", "text": "deleteToBeginningOfSubword()", "snippet": null, "description": "For each selection, if the selection is empty, delete all characters\nof the containing subword following the cursor. Otherwise delete the selected\ntext.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-deleteToBeginningOfSubword", "type": "method" }, { "name": "deleteToBeginningOfWord", "text": "deleteToBeginningOfWord()", "snippet": null, "description": "For each selection, if the selection is empty, delete all characters\nof the containing word that precede the cursor. Otherwise delete the\nselected text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-deleteToBeginningOfWord", "type": "method" }, { "name": "deleteToEndOfLine", "text": "deleteToEndOfLine()", "snippet": null, "description": "For each selection, if the selection is not empty, deletes the\nselection; otherwise, deletes all characters of the containing line\nfollowing the cursor. If the cursor is already at the end of the line,\ndeletes the following newline.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-deleteToEndOfLine", "type": "method" }, { "name": "deleteToEndOfSubword", "text": "deleteToEndOfSubword()", "snippet": null, "description": "For each selection, if the selection is empty, delete all characters\nof the containing subword following the cursor. Otherwise delete the selected\ntext.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-deleteToEndOfSubword", "type": "method" }, { "name": "deleteToEndOfWord", "text": "deleteToEndOfWord()", "snippet": null, "description": "For each selection, if the selection is empty, delete all characters\nof the containing word following the cursor. Otherwise delete the selected\ntext.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-deleteToEndOfWord", "type": "method" }, { "name": "deleteToNextWordBoundary", "text": "deleteToNextWordBoundary()", "snippet": null, "description": "Similar to {::deleteToEndOfWord}, but deletes only up to the\nnext word boundary.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-deleteToNextWordBoundary", "type": "method" }, { "name": "deleteToPreviousWordBoundary", "text": "deleteToPreviousWordBoundary()", "snippet": null, "description": "Similar to {::deleteToBeginningOfWord}, but deletes only back to the\nprevious word boundary.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-deleteToPreviousWordBoundary", "type": "method" }, { "name": "findMarkers", "text": null, "snippet": "findMarkers(${1:properties})", "description": "Find all {DisplayMarker}s on the default marker layer that\nmatch the given properties.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-findMarkers", "leftLabel": "Array", "type": "method" }, { "name": "foldAll", "text": "foldAll()", "snippet": null, "description": "Fold all foldable lines.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-foldAll", "type": "method" }, { "name": "foldAllAtIndentLevel", "text": null, "snippet": "foldAllAtIndentLevel(${1:level})", "description": "Fold all foldable lines at the given indent level.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-foldAllAtIndentLevel", "type": "method" }, { "name": "foldBufferRow", "text": null, "snippet": "foldBufferRow(${1:bufferRow})", "description": "Fold the given row in buffer coordinates based on its indentation\nlevel.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-foldBufferRow", "type": "method" }, { "name": "foldCurrentRow", "text": "foldCurrentRow()", "snippet": null, "description": "Fold the most recent cursor's row based on its indentation level.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-foldCurrentRow", "type": "method" }, { "name": "foldSelectedLines", "text": "foldSelectedLines()", "snippet": null, "description": "For each selection, fold the rows it intersects.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-foldSelectedLines", "type": "method" }, { "name": "getBuffer", "text": "getBuffer()", "snippet": null, "description": "Retrieves the current {TextBuffer}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getBuffer", "type": "method" }, { "name": "getCurrentParagraphBufferRange", "text": "getCurrentParagraphBufferRange()", "snippet": null, "description": "Get the {Range} of the paragraph surrounding the most recently added\ncursor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getCurrentParagraphBufferRange", "leftLabel": "Range", "type": "method" }, { "name": "getCursorAtScreenPosition", "text": null, "snippet": "getCursorAtScreenPosition(${1:position})", "description": "Get a {Cursor} at given screen coordinates {Point}", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getCursorAtScreenPosition", "leftLabel": "Cursor", "type": "method" }, { "name": "getCursorBufferPosition", "text": "getCursorBufferPosition()", "snippet": null, "description": "Get the position of the most recently added cursor in buffer\ncoordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getCursorBufferPosition", "leftLabel": "Point", "type": "method" }, { "name": "getCursorBufferPositions", "text": "getCursorBufferPositions()", "snippet": null, "description": "Get the position of all the cursor positions in buffer coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getCursorBufferPositions", "leftLabel": "Array", "type": "method" }, { "name": "getCursorScreenPosition", "text": "getCursorScreenPosition()", "snippet": null, "description": "Get the position of the most recently added cursor in screen\ncoordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getCursorScreenPosition", "leftLabel": "Point", "type": "method" }, { "name": "getCursorScreenPositions", "text": "getCursorScreenPositions()", "snippet": null, "description": "Get the position of all the cursor positions in screen coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getCursorScreenPositions", "leftLabel": "Array", "type": "method" }, { "name": "getCursors", "text": "getCursors()", "snippet": null, "description": "Get an Array of all {Cursor}s.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getCursors", "type": "method" }, { "name": "getCursorsOrderedByBufferPosition", "text": "getCursorsOrderedByBufferPosition()", "snippet": null, "description": "Get all {Cursors}s, ordered by their position in the buffer\ninstead of the order in which they were added.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getCursorsOrderedByBufferPosition", "leftLabel": "Array", "type": "method" }, { "name": "getDecorations", "text": null, "snippet": "getDecorations(${1:propertyFilter})", "description": "Get all decorations.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getDecorations", "leftLabel": "Array", "type": "method" }, { "name": "getDefaultMarkerLayer", "text": "getDefaultMarkerLayer()", "snippet": null, "description": "Get the default {DisplayMarkerLayer}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getDefaultMarkerLayer", "leftLabel": "DisplayMarkerLayer", "type": "method" }, { "name": "getEncoding", "text": "getEncoding()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getEncoding", "leftLabel": "String", "type": "method" }, { "name": "getGrammar", "text": "getGrammar()", "snippet": null, "description": "Get the current {Grammar} of this editor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getGrammar", "type": "method" }, { "name": "getGutters", "text": "getGutters()", "snippet": null, "description": "Get this editor's gutters.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getGutters", "leftLabel": "Array", "type": "method" }, { "name": "getHighlightDecorations", "text": null, "snippet": "getHighlightDecorations(${1:propertyFilter})", "description": "Get all decorations of type 'highlight'.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getHighlightDecorations", "leftLabel": "Array", "type": "method" }, { "name": "getLastBufferRow", "text": "getLastBufferRow()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getLastBufferRow", "leftLabel": "Number", "type": "method" }, { "name": "getLastCursor", "text": "getLastCursor()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getLastCursor", "leftLabel": "Cursor", "type": "method" }, { "name": "getLastScreenRow", "text": "getLastScreenRow()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getLastScreenRow", "leftLabel": "Number", "type": "method" }, { "name": "getLastSelection", "text": "getLastSelection()", "snippet": null, "description": "Get the most recently added {Selection}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getLastSelection", "leftLabel": "Selection", "type": "method" }, { "name": "getLineCount", "text": "getLineCount()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getLineCount", "leftLabel": "Number", "type": "method" }, { "name": "getLineDecorations", "text": null, "snippet": "getLineDecorations(${1:propertyFilter})", "description": "Get all decorations of type 'line'.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getLineDecorations", "leftLabel": "Array", "type": "method" }, { "name": "getLineNumberDecorations", "text": null, "snippet": "getLineNumberDecorations(${1:propertyFilter})", "description": "Get all decorations of type 'line-number'.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getLineNumberDecorations", "leftLabel": "Array", "type": "method" }, { "name": "getLongTitle", "text": "getLongTitle()", "snippet": null, "description": "Get unique title for display in other parts of the UI, such as\nthe window title.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getLongTitle", "leftLabel": "String", "type": "method" }, { "name": "getMarker", "text": null, "snippet": "getMarker(${1:id})", "description": "Get the {DisplayMarker} on the default layer for the given\nmarker id.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getMarker", "type": "method" }, { "name": "getMarkerCount", "text": "getMarkerCount()", "snippet": null, "description": "Get the number of markers in the default marker layer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getMarkerCount", "leftLabel": "Number", "type": "method" }, { "name": "getMarkerLayer", "text": null, "snippet": "getMarkerLayer(${1:id})", "description": "Get a {DisplayMarkerLayer} by id.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getMarkerLayer", "leftLabel": "DisplayMarkerLayer", "type": "method" }, { "name": "getMarkers", "text": "getMarkers()", "snippet": null, "description": "Get all {DisplayMarker}s on the default marker layer. Consider\nusing {::findMarkers}", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getMarkers", "type": "method" }, { "name": "getOverlayDecorations", "text": null, "snippet": "getOverlayDecorations(${1:propertyFilter})", "description": "Get all decorations of type 'overlay'.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getOverlayDecorations", "leftLabel": "Array", "type": "method" }, { "name": "getPath", "text": "getPath()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getPath", "leftLabel": "String", "type": "method" }, { "name": "getPlaceholderText", "text": "getPlaceholderText()", "snippet": null, "description": "Retrieves the greyed out placeholder of a mini editor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getPlaceholderText", "leftLabel": "String", "type": "method" }, { "name": "getRootScopeDescriptor", "text": "getRootScopeDescriptor()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getRootScopeDescriptor", "leftLabel": "ScopeDescriptor", "type": "method" }, { "name": "getScreenLineCount", "text": "getScreenLineCount()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getScreenLineCount", "leftLabel": "Number", "type": "method" }, { "name": "getSelectedBufferRange", "text": "getSelectedBufferRange()", "snippet": null, "description": "Get the {Range} of the most recently added selection in buffer\ncoordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getSelectedBufferRange", "leftLabel": "Range", "type": "method" }, { "name": "getSelectedBufferRanges", "text": "getSelectedBufferRanges()", "snippet": null, "description": "Get the {Range}s of all selections in buffer coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getSelectedBufferRanges", "leftLabel": "Array", "type": "method" }, { "name": "getSelectedScreenRange", "text": "getSelectedScreenRange()", "snippet": null, "description": "Get the {Range} of the most recently added selection in screen\ncoordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getSelectedScreenRange", "leftLabel": "Range", "type": "method" }, { "name": "getSelectedScreenRanges", "text": "getSelectedScreenRanges()", "snippet": null, "description": "Get the {Range}s of all selections in screen coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getSelectedScreenRanges", "leftLabel": "Array", "type": "method" }, { "name": "getSelectedText", "text": "getSelectedText()", "snippet": null, "description": "Get the selected text of the most recently added selection.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getSelectedText", "leftLabel": "String", "type": "method" }, { "name": "getSelections", "text": "getSelections()", "snippet": null, "description": "Get current {Selection}s.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getSelections", "leftLabel": "Array", "type": "method" }, { "name": "getSelectionsOrderedByBufferPosition", "text": "getSelectionsOrderedByBufferPosition()", "snippet": null, "description": "Get all {Selection}s, ordered by their position in the buffer\ninstead of the order in which they were added.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getSelectionsOrderedByBufferPosition", "leftLabel": "Array", "type": "method" }, { "name": "getSoftTabs", "text": "getSoftTabs()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getSoftTabs", "leftLabel": "Boolean", "type": "method" }, { "name": "getSoftWrapColumn", "text": "getSoftWrapColumn()", "snippet": null, "description": "Gets the column at which column will soft wrap", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getSoftWrapColumn", "type": "method" }, { "name": "getTabLength", "text": "getTabLength()", "snippet": null, "description": "Get the on-screen length of tab characters.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getTabLength", "leftLabel": "Number", "type": "method" }, { "name": "getTabText", "text": "getTabText()", "snippet": null, "description": "Get the text representing a single level of indent.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getTabText", "leftLabel": "String", "type": "method" }, { "name": "getText", "text": "getText()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getText", "leftLabel": "String", "type": "method" }, { "name": "getTextInBufferRange", "text": null, "snippet": "getTextInBufferRange(${1:range})", "description": "Get the text in the given {Range} in buffer coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getTextInBufferRange", "leftLabel": "String", "type": "method" }, { "name": "getTitle", "text": "getTitle()", "snippet": null, "description": "Get the editor's title for display in other parts of the\nUI such as the tabs.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getTitle", "leftLabel": "String", "type": "method" }, { "name": "getWordUnderCursor", "text": null, "snippet": "getWordUnderCursor(${1:options})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-getWordUnderCursor", "leftLabel": null, "type": "method" }, { "name": "groupChangesSinceCheckpoint", "text": null, "snippet": "groupChangesSinceCheckpoint(${1:checkpoint})", "description": "Group all changes since the given checkpoint into a single\ntransaction for purposes of undo/redo.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-groupChangesSinceCheckpoint", "leftLabel": "Boolean", "type": "method" }, { "name": "gutterWithName", "text": "gutterWithName()", "snippet": null, "description": "Get the gutter with the given name.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-gutterWithName", "leftLabel": "Gutter", "type": "method" }, { "name": "hasMultipleCursors", "text": "hasMultipleCursors()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-hasMultipleCursors", "leftLabel": "Boolean", "type": "method" }, { "name": "indentLevelForLine", "text": null, "snippet": "indentLevelForLine(${1:line})", "description": "Get the indentation level of the given line of text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-indentLevelForLine", "leftLabel": "Number", "type": "method" }, { "name": "indentSelectedRows", "text": "indentSelectedRows()", "snippet": null, "description": "Indent rows intersecting selections by one level.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-indentSelectedRows", "type": "method" }, { "name": "indentationForBufferRow", "text": null, "snippet": "indentationForBufferRow(${1:bufferRow})", "description": "Get the indentation level of the given buffer row.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-indentationForBufferRow", "leftLabel": "Number", "type": "method" }, { "name": "insertNewline", "text": "insertNewline()", "snippet": null, "description": "For each selection, replace the selected text with a newline.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-insertNewline", "type": "method" }, { "name": "insertNewlineAbove", "text": "insertNewlineAbove()", "snippet": null, "description": "For each cursor, insert a newline at the end of the preceding line.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-insertNewlineAbove", "type": "method" }, { "name": "insertNewlineBelow", "text": "insertNewlineBelow()", "snippet": null, "description": "For each cursor, insert a newline at beginning the following line.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-insertNewlineBelow", "type": "method" }, { "name": "insertText", "text": null, "snippet": "insertText(${1:text}, ${2:options})", "description": "For each selection, replace the selected text with the given text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-insertText", "leftLabel": "Range", "type": "method" }, { "name": "isBufferRowCommented", "text": "isBufferRowCommented()", "snippet": null, "description": "Determine if the given row is entirely a comment", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-isBufferRowCommented", "type": "method" }, { "name": "isEmpty", "text": "isEmpty()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-isEmpty", "leftLabel": "Boolean", "type": "method" }, { "name": "isFoldableAtBufferRow", "text": null, "snippet": "isFoldableAtBufferRow(${1:bufferRow})", "description": "Determine whether the given row in buffer coordinates is foldable.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-isFoldableAtBufferRow", "leftLabel": "Boolean", "type": "method" }, { "name": "isFoldableAtScreenRow", "text": null, "snippet": "isFoldableAtScreenRow(${1:bufferRow})", "description": "Determine whether the given row in screen coordinates is foldable.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-isFoldableAtScreenRow", "leftLabel": "Boolean", "type": "method" }, { "name": "isFoldedAtBufferRow", "text": null, "snippet": "isFoldedAtBufferRow(${1:bufferRow})", "description": "Determine whether the given row in buffer coordinates is folded.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-isFoldedAtBufferRow", "leftLabel": "Boolean", "type": "method" }, { "name": "isFoldedAtCursorRow", "text": "isFoldedAtCursorRow()", "snippet": null, "description": "Determine whether the most recently added cursor's row is folded.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-isFoldedAtCursorRow", "leftLabel": "Boolean", "type": "method" }, { "name": "isFoldedAtScreenRow", "text": null, "snippet": "isFoldedAtScreenRow(${1:screenRow})", "description": "Determine whether the given row in screen coordinates is folded.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-isFoldedAtScreenRow", "leftLabel": "Boolean", "type": "method" }, { "name": "isModified", "text": "isModified()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-isModified", "leftLabel": "Boolean", "type": "method" }, { "name": "isSoftWrapped", "text": "isSoftWrapped()", "snippet": null, "description": "Determine whether lines in this editor are soft-wrapped.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-isSoftWrapped", "leftLabel": "Boolean", "type": "method" }, { "name": "lineTextForBufferRow", "text": null, "snippet": "lineTextForBufferRow(${1:bufferRow})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-lineTextForBufferRow", "leftLabel": "String", "type": "method" }, { "name": "lineTextForScreenRow", "text": null, "snippet": "lineTextForScreenRow(${1:screenRow})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-lineTextForScreenRow", "leftLabel": "String", "type": "method" }, { "name": "lowerCase", "text": "lowerCase()", "snippet": null, "description": "Convert the selected text to lower case.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-lowerCase", "type": "method" }, { "name": "markBufferPosition", "text": null, "snippet": "markBufferPosition(${1:bufferPosition}, ${2:options})", "description": "Create a marker on the default marker layer with the given buffer\nposition and no tail. To group multiple markers together in their own\nprivate layer, see {::addMarkerLayer}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-markBufferPosition", "leftLabel": "DisplayMarker", "type": "method" }, { "name": "markBufferRange", "text": null, "snippet": "markBufferRange(${1:range}, ${2:properties})", "description": "Create a marker on the default marker layer with the given range\nin buffer coordinates. This marker will maintain its logical location as the\nbuffer is changed, so if you mark a particular word, the marker will remain\nover that word even if the word's location in the buffer changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-markBufferRange", "leftLabel": "DisplayMarker", "type": "method" }, { "name": "markScreenPosition", "text": null, "snippet": "markScreenPosition(${1:screenPosition}, ${2:options})", "description": "Create a marker on the default marker layer with the given screen\nposition and no tail. To group multiple markers together in their own\nprivate layer, see {::addMarkerLayer}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-markScreenPosition", "leftLabel": "DisplayMarker", "type": "method" }, { "name": "markScreenRange", "text": null, "snippet": "markScreenRange(${1:range}, ${2:properties})", "description": "Create a marker on the default marker layer with the given range\nin screen coordinates. This marker will maintain its logical location as the\nbuffer is changed, so if you mark a particular word, the marker will remain\nover that word even if the word's location in the buffer changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-markScreenRange", "leftLabel": "DisplayMarker", "type": "method" }, { "name": "moveDown", "text": null, "snippet": "moveDown(${1:lineCount})", "description": "Move every cursor down one row in screen coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveDown", "type": "method" }, { "name": "moveLeft", "text": null, "snippet": "moveLeft(${1:columnCount})", "description": "Move every cursor left one column.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveLeft", "type": "method" }, { "name": "moveRight", "text": null, "snippet": "moveRight(${1:columnCount})", "description": "Move every cursor right one column.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveRight", "type": "method" }, { "name": "moveToBeginningOfLine", "text": "moveToBeginningOfLine()", "snippet": null, "description": "Move every cursor to the beginning of its line in buffer coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveToBeginningOfLine", "type": "method" }, { "name": "moveToBeginningOfNextParagraph", "text": "moveToBeginningOfNextParagraph()", "snippet": null, "description": "Move every cursor to the beginning of the next paragraph.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveToBeginningOfNextParagraph", "type": "method" }, { "name": "moveToBeginningOfNextWord", "text": "moveToBeginningOfNextWord()", "snippet": null, "description": "Move every cursor to the beginning of the next word.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveToBeginningOfNextWord", "type": "method" }, { "name": "moveToBeginningOfPreviousParagraph", "text": "moveToBeginningOfPreviousParagraph()", "snippet": null, "description": "Move every cursor to the beginning of the previous paragraph.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveToBeginningOfPreviousParagraph", "type": "method" }, { "name": "moveToBeginningOfScreenLine", "text": "moveToBeginningOfScreenLine()", "snippet": null, "description": "Move every cursor to the beginning of its line in screen coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveToBeginningOfScreenLine", "type": "method" }, { "name": "moveToBeginningOfWord", "text": "moveToBeginningOfWord()", "snippet": null, "description": "Move every cursor to the beginning of its surrounding word.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveToBeginningOfWord", "type": "method" }, { "name": "moveToBottom", "text": "moveToBottom()", "snippet": null, "description": "Move every cursor to the bottom of the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveToBottom", "type": "method" }, { "name": "moveToEndOfLine", "text": "moveToEndOfLine()", "snippet": null, "description": "Move every cursor to the end of its line in buffer coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveToEndOfLine", "type": "method" }, { "name": "moveToEndOfScreenLine", "text": "moveToEndOfScreenLine()", "snippet": null, "description": "Move every cursor to the end of its line in screen coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveToEndOfScreenLine", "type": "method" }, { "name": "moveToEndOfWord", "text": "moveToEndOfWord()", "snippet": null, "description": "Move every cursor to the end of its surrounding word.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveToEndOfWord", "type": "method" }, { "name": "moveToFirstCharacterOfLine", "text": "moveToFirstCharacterOfLine()", "snippet": null, "description": "Move every cursor to the first non-whitespace character of its line.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveToFirstCharacterOfLine", "type": "method" }, { "name": "moveToNextSubwordBoundary", "text": "moveToNextSubwordBoundary()", "snippet": null, "description": "Move every cursor to the next subword boundary.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveToNextSubwordBoundary", "type": "method" }, { "name": "moveToNextWordBoundary", "text": "moveToNextWordBoundary()", "snippet": null, "description": "Move every cursor to the next word boundary.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveToNextWordBoundary", "type": "method" }, { "name": "moveToPreviousSubwordBoundary", "text": "moveToPreviousSubwordBoundary()", "snippet": null, "description": "Move every cursor to the previous subword boundary.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveToPreviousSubwordBoundary", "type": "method" }, { "name": "moveToPreviousWordBoundary", "text": "moveToPreviousWordBoundary()", "snippet": null, "description": "Move every cursor to the previous word boundary.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveToPreviousWordBoundary", "type": "method" }, { "name": "moveToTop", "text": "moveToTop()", "snippet": null, "description": "Move every cursor to the top of the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveToTop", "type": "method" }, { "name": "moveUp", "text": null, "snippet": "moveUp(${1:lineCount})", "description": "Move every cursor up one row in screen coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-moveUp", "type": "method" }, { "name": "mutateSelectedText", "text": null, "snippet": "mutateSelectedText(${1:fn})", "description": "Mutate the text of all the selections in a single transaction.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-mutateSelectedText", "type": "method" }, { "name": "observeCursors", "text": null, "snippet": "observeCursors(${1:callback})", "description": "Calls your `callback` when a {Cursor} is added to the editor.\nImmediately calls your callback for each existing cursor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-observeCursors", "leftLabel": "Disposable", "type": "method" }, { "name": "observeDecorations", "text": null, "snippet": "observeDecorations(${1:callback})", "description": "Calls your `callback` with each {Decoration} added to the editor.\nCalls your `callback` immediately for any existing decorations.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-observeDecorations", "leftLabel": "Disposable", "type": "method" }, { "name": "observeGrammar", "text": null, "snippet": "observeGrammar(${1:callback})", "description": "Calls your `callback` when the grammar that interprets and\ncolorizes the text has been changed. Immediately calls your callback with\nthe current grammar.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-observeGrammar", "leftLabel": "Disposable", "type": "method" }, { "name": "observeGutters", "text": null, "snippet": "observeGutters(${1:callback})", "description": "Calls your `callback` when a {Gutter} is added to the editor.\nImmediately calls your callback for each existing gutter.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-observeGutters", "leftLabel": "Disposable", "type": "method" }, { "name": "observeSelections", "text": null, "snippet": "observeSelections(${1:callback})", "description": "Calls your `callback` when a {Selection} is added to the editor.\nImmediately calls your callback for each existing selection.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-observeSelections", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidAddCursor", "text": null, "snippet": "onDidAddCursor(${1:callback})", "description": "Calls your `callback` when a {Cursor} is added to the editor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidAddCursor", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidAddDecoration", "text": null, "snippet": "onDidAddDecoration(${1:callback})", "description": "Calls your `callback` when a {Decoration} is added to the editor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidAddDecoration", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidAddGutter", "text": null, "snippet": "onDidAddGutter(${1:callback})", "description": "Calls your `callback` when a {Gutter} is added to the editor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidAddGutter", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidAddSelection", "text": null, "snippet": "onDidAddSelection(${1:callback})", "description": "Calls your `callback` when a {Selection} is added to the editor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidAddSelection", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChange", "text": null, "snippet": "onDidChange(${1:callback})", "description": "Invoke the given callback synchronously when the content of the\nbuffer changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidChange", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeCursorPosition", "text": null, "snippet": "onDidChangeCursorPosition(${1:callback})", "description": "Calls your `callback` when a {Cursor} is moved. If there are\nmultiple cursors, your callback will be called for each cursor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidChangeCursorPosition", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeEncoding", "text": null, "snippet": "onDidChangeEncoding(${1:callback})", "description": "Calls your `callback` when the buffer's encoding has changed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidChangeEncoding", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeGrammar", "text": null, "snippet": "onDidChangeGrammar(${1:callback})", "description": "Calls your `callback` when the grammar that interprets and\ncolorizes the text has been changed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidChangeGrammar", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeModified", "text": null, "snippet": "onDidChangeModified(${1:callback})", "description": "Calls your `callback` when the result of {::isModified} changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidChangeModified", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangePath", "text": null, "snippet": "onDidChangePath(${1:callback})", "description": "Calls your `callback` when the buffer's path, and therefore title, has changed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidChangePath", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangePlaceholderText", "text": null, "snippet": "onDidChangePlaceholderText(${1:callback})", "description": "Calls your `callback` when the placeholder text is changed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidChangePlaceholderText", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeSelectionRange", "text": null, "snippet": "onDidChangeSelectionRange(${1:callback})", "description": "Calls your `callback` when a selection's screen range changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidChangeSelectionRange", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeSoftWrapped", "text": null, "snippet": "onDidChangeSoftWrapped(${1:callback})", "description": "Calls your `callback` when soft wrap was enabled or disabled.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidChangeSoftWrapped", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeTitle", "text": null, "snippet": "onDidChangeTitle(${1:callback})", "description": "Calls your `callback` when the buffer's title has changed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidChangeTitle", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidConflict", "text": null, "snippet": "onDidConflict(${1:callback})", "description": "Calls your `callback` when the buffer's underlying file changes on\ndisk at a moment when the result of {::isModified} is true.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidConflict", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroy", "text": null, "snippet": "onDidDestroy(${1:callback})", "description": "Invoke the given callback when the editor is destroyed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidDestroy", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidInsertText", "text": null, "snippet": "onDidInsertText(${1:callback})", "description": "Calls your `callback` after text has been inserted.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidInsertText", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidRemoveCursor", "text": null, "snippet": "onDidRemoveCursor(${1:callback})", "description": "Calls your `callback` when a {Cursor} is removed from the editor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidRemoveCursor", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidRemoveDecoration", "text": null, "snippet": "onDidRemoveDecoration(${1:callback})", "description": "Calls your `callback` when a {Decoration} is removed from the editor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidRemoveDecoration", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidRemoveGutter", "text": null, "snippet": "onDidRemoveGutter(${1:callback})", "description": "Calls your `callback` when a {Gutter} is removed from the editor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidRemoveGutter", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidRemoveSelection", "text": null, "snippet": "onDidRemoveSelection(${1:callback})", "description": "Calls your `callback` when a {Selection} is removed from the editor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidRemoveSelection", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidSave", "text": null, "snippet": "onDidSave(${1:callback})", "description": "Invoke the given callback after the buffer is saved to disk.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidSave", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidStopChanging", "text": null, "snippet": "onDidStopChanging(${1:callback})", "description": "Invoke `callback` when the buffer's contents change. It is\nemit asynchronously 300ms after the last buffer change. This is a good place\nto handle changes to the buffer without compromising typing performance.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onDidStopChanging", "leftLabel": "Disposable", "type": "method" }, { "name": "onWillInsertText", "text": null, "snippet": "onWillInsertText(${1:callback})", "description": "Calls your `callback` before text has been inserted.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-onWillInsertText", "leftLabel": "Disposable", "type": "method" }, { "name": "outdentSelectedRows", "text": "outdentSelectedRows()", "snippet": null, "description": "Outdent rows intersecting selections by one level.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-outdentSelectedRows", "type": "method" }, { "name": "pasteText", "text": null, "snippet": "pasteText(${1:options})", "description": "For each selection, replace the selected text with the contents of\nthe clipboard.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-pasteText", "type": "method" }, { "name": "redo", "text": "redo()", "snippet": null, "description": "Redo the last change.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-redo", "type": "method" }, { "name": "revertToCheckpoint", "text": null, "snippet": "revertToCheckpoint(${1:checkpoint})", "description": "Revert the buffer to the state it was in when the given\ncheckpoint was created.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-revertToCheckpoint", "leftLabel": "Boolean", "type": "method" }, { "name": "save", "text": "save()", "snippet": null, "description": "Saves the editor's text buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-save", "type": "method" }, { "name": "saveAs", "text": null, "snippet": "saveAs(${1:filePath})", "description": "Saves the editor's text buffer as the given path.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-saveAs", "type": "method" }, { "name": "scan", "text": null, "snippet": "scan(${1:regex}, ${2:options}, ${3:iterator})", "description": "Scan regular expression matches in the entire buffer, calling the\ngiven iterator function on each match.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-scan", "type": "method" }, { "name": "scanInBufferRange", "text": null, "snippet": "scanInBufferRange(${1:regex}, ${2:range}, ${3:iterator})", "description": "Scan regular expression matches in a given range, calling the given\niterator function on each match.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-scanInBufferRange", "type": "method" }, { "name": "scopeDescriptorForBufferPosition", "text": null, "snippet": "scopeDescriptorForBufferPosition(${1:bufferPosition})", "description": "Get the syntactic scopeDescriptor for the given position in buffer\ncoordinates. Useful with {Config::get}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-scopeDescriptorForBufferPosition", "leftLabel": "ScopeDescriptor", "type": "method" }, { "name": "screenPositionForBufferPosition", "text": null, "snippet": "screenPositionForBufferPosition(${1:bufferPosition}, ${2:options})", "description": "Convert a position in buffer-coordinates to screen-coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-screenPositionForBufferPosition", "leftLabel": "Point", "type": "method" }, { "name": "screenRangeForBufferRange", "text": null, "snippet": "screenRangeForBufferRange(${1:bufferRange})", "description": "Convert a range in buffer-coordinates to screen-coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-screenRangeForBufferRange", "leftLabel": "Range", "type": "method" }, { "name": "scrollToBufferPosition", "text": null, "snippet": "scrollToBufferPosition(${1:bufferPosition}, ${2:options})", "description": "Scrolls the editor to the given buffer position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-scrollToBufferPosition", "type": "method" }, { "name": "scrollToCursorPosition", "text": null, "snippet": "scrollToCursorPosition(${1:options})", "description": "Scroll the editor to reveal the most recently added cursor if it is\noff-screen.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-scrollToCursorPosition", "type": "method" }, { "name": "scrollToScreenPosition", "text": null, "snippet": "scrollToScreenPosition(${1:screenPosition}, ${2:options})", "description": "Scrolls the editor to the given screen position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-scrollToScreenPosition", "type": "method" }, { "name": "selectAll", "text": "selectAll()", "snippet": null, "description": "Select all text in the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectAll", "type": "method" }, { "name": "selectDown", "text": null, "snippet": "selectDown(${1:rowCount})", "description": "Move the cursor of each selection one character downward while\npreserving the selection's tail position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectDown", "type": "method" }, { "name": "selectLeft", "text": null, "snippet": "selectLeft(${1:columnCount})", "description": "Move the cursor of each selection one character leftward while\npreserving the selection's tail position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectLeft", "type": "method" }, { "name": "selectLinesContainingCursors", "text": "selectLinesContainingCursors()", "snippet": null, "description": "For each cursor, select the containing line.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectLinesContainingCursors", "type": "method" }, { "name": "selectMarker", "text": null, "snippet": "selectMarker(${1:marker})", "description": "Select the range of the given marker if it is valid.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectMarker", "leftLabel": "Range", "type": "method" }, { "name": "selectRight", "text": null, "snippet": "selectRight(${1:columnCount})", "description": "Move the cursor of each selection one character rightward while\npreserving the selection's tail position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectRight", "type": "method" }, { "name": "selectToBeginningOfLine", "text": "selectToBeginningOfLine()", "snippet": null, "description": "Move the cursor of each selection to the beginning of its line\nwhile preserving the selection's tail position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectToBeginningOfLine", "type": "method" }, { "name": "selectToBeginningOfNextParagraph", "text": "selectToBeginningOfNextParagraph()", "snippet": null, "description": "Expand selections to the beginning of the next paragraph.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectToBeginningOfNextParagraph", "type": "method" }, { "name": "selectToBeginningOfNextWord", "text": "selectToBeginningOfNextWord()", "snippet": null, "description": "Expand selections to the beginning of the next word.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectToBeginningOfNextWord", "type": "method" }, { "name": "selectToBeginningOfPreviousParagraph", "text": "selectToBeginningOfPreviousParagraph()", "snippet": null, "description": "Expand selections to the beginning of the next paragraph.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectToBeginningOfPreviousParagraph", "type": "method" }, { "name": "selectToBeginningOfWord", "text": "selectToBeginningOfWord()", "snippet": null, "description": "Expand selections to the beginning of their containing word.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectToBeginningOfWord", "type": "method" }, { "name": "selectToBottom", "text": "selectToBottom()", "snippet": null, "description": "Selects from the top of the first selection in the buffer to the end\nof the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectToBottom", "type": "method" }, { "name": "selectToBufferPosition", "text": null, "snippet": "selectToBufferPosition(${1:position})", "description": "Select from the current cursor position to the given position in\nbuffer coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectToBufferPosition", "type": "method" }, { "name": "selectToEndOfLine", "text": "selectToEndOfLine()", "snippet": null, "description": "Move the cursor of each selection to the end of its line while\npreserving the selection's tail position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectToEndOfLine", "type": "method" }, { "name": "selectToEndOfWord", "text": "selectToEndOfWord()", "snippet": null, "description": "Expand selections to the end of their containing word.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectToEndOfWord", "type": "method" }, { "name": "selectToFirstCharacterOfLine", "text": "selectToFirstCharacterOfLine()", "snippet": null, "description": "Move the cursor of each selection to the first non-whitespace\ncharacter of its line while preserving the selection's tail position. If the\ncursor is already on the first character of the line, move it to the\nbeginning of the line.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectToFirstCharacterOfLine", "type": "method" }, { "name": "selectToNextSubwordBoundary", "text": "selectToNextSubwordBoundary()", "snippet": null, "description": "For each selection, move its cursor to the next subword boundary\nwhile maintaining the selection's tail position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectToNextSubwordBoundary", "type": "method" }, { "name": "selectToNextWordBoundary", "text": "selectToNextWordBoundary()", "snippet": null, "description": "For each selection, move its cursor to the next word boundary while\nmaintaining the selection's tail position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectToNextWordBoundary", "type": "method" }, { "name": "selectToPreviousSubwordBoundary", "text": "selectToPreviousSubwordBoundary()", "snippet": null, "description": "For each selection, move its cursor to the preceding subword\nboundary while maintaining the selection's tail position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectToPreviousSubwordBoundary", "type": "method" }, { "name": "selectToPreviousWordBoundary", "text": "selectToPreviousWordBoundary()", "snippet": null, "description": "For each selection, move its cursor to the preceding word boundary\nwhile maintaining the selection's tail position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectToPreviousWordBoundary", "type": "method" }, { "name": "selectToScreenPosition", "text": null, "snippet": "selectToScreenPosition(${1:position})", "description": "Select from the current cursor position to the given position in\nscreen coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectToScreenPosition", "type": "method" }, { "name": "selectToTop", "text": "selectToTop()", "snippet": null, "description": "Select from the top of the buffer to the end of the last selection\nin the buffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectToTop", "type": "method" }, { "name": "selectUp", "text": null, "snippet": "selectUp(${1:rowCount})", "description": "Move the cursor of each selection one character upward while\npreserving the selection's tail position.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectUp", "type": "method" }, { "name": "selectWordsContainingCursors", "text": "selectWordsContainingCursors()", "snippet": null, "description": "Select the word surrounding each cursor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectWordsContainingCursors", "type": "method" }, { "name": "selectionIntersectsBufferRange", "text": null, "snippet": "selectionIntersectsBufferRange(${1:bufferRange})", "description": "Determine if a given range in buffer coordinates intersects a\nselection.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-selectionIntersectsBufferRange", "leftLabel": "Boolean", "type": "method" }, { "name": "setCursorBufferPosition", "text": null, "snippet": "setCursorBufferPosition(${1:position}, ${2:options})", "description": "Move the cursor to the given position in buffer coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-setCursorBufferPosition", "type": "method" }, { "name": "setCursorScreenPosition", "text": null, "snippet": "setCursorScreenPosition(${1:position}, ${2:options})", "description": "Move the cursor to the given position in screen coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-setCursorScreenPosition", "type": "method" }, { "name": "setEncoding", "text": null, "snippet": "setEncoding(${1:encoding})", "description": "Set the character set encoding to use in this editor's text\nbuffer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-setEncoding", "type": "method" }, { "name": "setGrammar", "text": null, "snippet": "setGrammar(${1:grammar})", "description": "Set the current {Grammar} of this editor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-setGrammar", "type": "method" }, { "name": "setIndentationForBufferRow", "text": null, "snippet": "setIndentationForBufferRow(${1:bufferRow}, ${2:newLevel}, ${3:options})", "description": "Set the indentation level for the given buffer row.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-setIndentationForBufferRow", "type": "method" }, { "name": "setPlaceholderText", "text": null, "snippet": "setPlaceholderText(${1:placeholderText})", "description": "Set the greyed out placeholder of a mini editor. Placeholder text\nwill be displayed when the editor has no content.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-setPlaceholderText", "type": "method" }, { "name": "setSelectedBufferRange", "text": null, "snippet": "setSelectedBufferRange(${1:bufferRange}, ${2:options})", "description": "Set the selected range in buffer coordinates. If there are multiple\nselections, they are reduced to a single selection with the given range.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-setSelectedBufferRange", "type": "method" }, { "name": "setSelectedBufferRanges", "text": null, "snippet": "setSelectedBufferRanges(${1:bufferRanges}, ${2:options})", "description": "Set the selected ranges in buffer coordinates. If there are multiple\nselections, they are replaced by new selections with the given ranges.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-setSelectedBufferRanges", "type": "method" }, { "name": "setSelectedScreenRange", "text": null, "snippet": "setSelectedScreenRange(${1:screenRange}, ${2:options})", "description": "Set the selected range in screen coordinates. If there are multiple\nselections, they are reduced to a single selection with the given range.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-setSelectedScreenRange", "type": "method" }, { "name": "setSelectedScreenRanges", "text": null, "snippet": "setSelectedScreenRanges(${1:screenRanges}, ${2:options})", "description": "Set the selected ranges in screen coordinates. If there are multiple\nselections, they are replaced by new selections with the given ranges.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-setSelectedScreenRanges", "type": "method" }, { "name": "setSoftTabs", "text": null, "snippet": "setSoftTabs(${1:softTabs})", "description": "Enable or disable soft tabs for this editor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-setSoftTabs", "type": "method" }, { "name": "setSoftWrapped", "text": null, "snippet": "setSoftWrapped(${1:softWrapped})", "description": "Enable or disable soft wrapping for this editor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-setSoftWrapped", "leftLabel": "Boolean", "type": "method" }, { "name": "setTabLength", "text": null, "snippet": "setTabLength(${1:tabLength})", "description": "Set the on-screen length of tab characters. Setting this to a\n{Number} This will override the `editor.tabLength` setting.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-setTabLength", "type": "method" }, { "name": "setText", "text": null, "snippet": "setText(${1:text})", "description": "Replaces the entire contents of the buffer with the given {String}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-setText", "type": "method" }, { "name": "setTextInBufferRange", "text": null, "snippet": "setTextInBufferRange(${1:range}, ${2:text}, ${3:options})", "description": "Set the text in the given {Range} in buffer coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-setTextInBufferRange", "leftLabel": "Range", "type": "method" }, { "name": "toggleFoldAtBufferRow", "text": "toggleFoldAtBufferRow()", "snippet": null, "description": "Fold the given buffer row if it isn't currently folded, and unfold\nit otherwise.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-toggleFoldAtBufferRow", "type": "method" }, { "name": "toggleLineCommentsInSelection", "text": "toggleLineCommentsInSelection()", "snippet": null, "description": "Toggle line comments for rows intersecting selections.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-toggleLineCommentsInSelection", "type": "method" }, { "name": "toggleSoftTabs", "text": "toggleSoftTabs()", "snippet": null, "description": "Toggle soft tabs for this editor", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-toggleSoftTabs", "type": "method" }, { "name": "toggleSoftWrapped", "text": "toggleSoftWrapped()", "snippet": null, "description": "Toggle soft wrapping for this editor", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-toggleSoftWrapped", "leftLabel": "Boolean", "type": "method" }, { "name": "transact", "text": null, "snippet": "transact(${1:groupingInterval}, ${2:fn})", "description": "Batch multiple operations as a single undo/redo step.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-transact", "type": "method" }, { "name": "transpose", "text": "transpose()", "snippet": null, "description": "For each selection, transpose the selected text.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-transpose", "type": "method" }, { "name": "undo", "text": "undo()", "snippet": null, "description": "Undo the last change.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-undo", "type": "method" }, { "name": "unfoldAll", "text": "unfoldAll()", "snippet": null, "description": "Unfold all existing folds.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-unfoldAll", "type": "method" }, { "name": "unfoldBufferRow", "text": null, "snippet": "unfoldBufferRow(${1:bufferRow})", "description": "Unfold all folds containing the given row in buffer coordinates.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-unfoldBufferRow", "type": "method" }, { "name": "unfoldCurrentRow", "text": "unfoldCurrentRow()", "snippet": null, "description": "Unfold the most recent cursor's row by one level.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-unfoldCurrentRow", "type": "method" }, { "name": "upperCase", "text": "upperCase()", "snippet": null, "description": "Convert the selected text to upper case.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-upperCase", "type": "method" }, { "name": "usesSoftTabs", "text": "usesSoftTabs()", "snippet": null, "description": "Determine if the buffer uses hard or soft tabs.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TextEditor#instance-usesSoftTabs", "leftLabel": null, "type": "method" } ], "ThemeManager": [ { "name": "getActiveThemeNames", "text": "getActiveThemeNames()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/ThemeManager#instance-getActiveThemeNames", "leftLabel": "Array", "type": "method" }, { "name": "getActiveThemes", "text": "getActiveThemes()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/ThemeManager#instance-getActiveThemes", "leftLabel": "Array", "type": "method" }, { "name": "getEnabledThemeNames", "text": "getEnabledThemeNames()", "snippet": null, "description": "Get the enabled theme names from the config.", "descriptionMoreURL": "https://atom.io/docs/api/latest/ThemeManager#instance-getEnabledThemeNames", "leftLabel": null, "type": "method" }, { "name": "getLoadedThemeNames", "text": "getLoadedThemeNames()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/ThemeManager#instance-getLoadedThemeNames", "leftLabel": "Array", "type": "method" }, { "name": "getLoadedThemes", "text": "getLoadedThemes()", "snippet": null, "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/ThemeManager#instance-getLoadedThemes", "leftLabel": "Array", "type": "method" }, { "name": "onDidChangeActiveThemes", "text": null, "snippet": "onDidChangeActiveThemes(${1:callback})", "description": "Invoke `callback` when style sheet changes associated with\nupdating the list of active themes have completed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/ThemeManager#instance-onDidChangeActiveThemes", "type": "method" } ], "TooltipManager": [ { "name": "add", "text": null, "snippet": "add(${1:target}, ${2:options})", "description": "Add a tooltip to the given element.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TooltipManager#instance-add", "leftLabel": "Disposable", "type": "method" }, { "name": "findTooltips", "text": null, "snippet": "findTooltips(${1:target})", "description": "Find the tooltips that have been applied to the given element.", "descriptionMoreURL": "https://atom.io/docs/api/latest/TooltipManager#instance-findTooltips", "leftLabel": "Array", "type": "method" } ], "ViewRegistry": [ { "name": "addViewProvider", "text": null, "snippet": "addViewProvider(${1:modelConstructor}, ${2:createView})", "description": "Add a provider that will be used to construct views in the\nworkspace's view layer based on model objects in its model layer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/ViewRegistry#instance-addViewProvider", "leftLabel": "Disposable", "type": "method" }, { "name": "getView", "text": "getView()", "snippet": null, "description": "Get the view associated with an object in the workspace.", "descriptionMoreURL": "https://atom.io/docs/api/latest/ViewRegistry#instance-getView", "leftLabel": null, "type": "method" } ], "Workspace": [ { "name": "activateNextPane", "text": "activateNextPane()", "snippet": null, "description": "Make the next pane active.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-activateNextPane", "type": "method" }, { "name": "activatePreviousPane", "text": "activatePreviousPane()", "snippet": null, "description": "Make the previous pane active.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-activatePreviousPane", "type": "method" }, { "name": "addBottomPanel", "text": null, "snippet": "addBottomPanel(${1:options})", "description": "Adds a panel item to the bottom of the editor window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-addBottomPanel", "leftLabel": "Panel", "type": "method" }, { "name": "addFooterPanel", "text": null, "snippet": "addFooterPanel(${1:options})", "description": "Adds a panel item to the footer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-addFooterPanel", "leftLabel": "Panel", "type": "method" }, { "name": "addHeaderPanel", "text": null, "snippet": "addHeaderPanel(${1:options})", "description": "Adds a panel item to the header.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-addHeaderPanel", "leftLabel": "Panel", "type": "method" }, { "name": "addLeftPanel", "text": null, "snippet": "addLeftPanel(${1:options})", "description": "Adds a panel item to the left of the editor window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-addLeftPanel", "leftLabel": "Panel", "type": "method" }, { "name": "addModalPanel", "text": null, "snippet": "addModalPanel(${1:options})", "description": "Adds a panel item as a modal dialog.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-addModalPanel", "leftLabel": "Panel", "type": "method" }, { "name": "addOpener", "text": null, "snippet": "addOpener(${1:opener})", "description": "Register an opener for a uri.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-addOpener", "leftLabel": "Disposable", "type": "method" }, { "name": "addRightPanel", "text": null, "snippet": "addRightPanel(${1:options})", "description": "Adds a panel item to the right of the editor window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-addRightPanel", "leftLabel": "Panel", "type": "method" }, { "name": "addTopPanel", "text": null, "snippet": "addTopPanel(${1:options})", "description": "Adds a panel item to the top of the editor window above the tabs.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-addTopPanel", "leftLabel": "Panel", "type": "method" }, { "name": "buildTextEditor", "text": "buildTextEditor()", "snippet": null, "description": "Create a new text editor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-buildTextEditor", "leftLabel": "TextEditor", "type": "method" }, { "name": "createItemForURI", "text": null, "snippet": "createItemForURI(${1:uri})", "description": "Creates a new item that corresponds to the provided URI.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-createItemForURI", "leftLabel": "Promise", "type": "method" }, { "name": "getActivePane", "text": "getActivePane()", "snippet": null, "description": "Get the active {Pane}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getActivePane", "leftLabel": "Pane", "type": "method" }, { "name": "getActivePaneContainer", "text": "getActivePaneContainer()", "snippet": null, "description": "Get the most recently focused pane container.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getActivePaneContainer", "leftLabel": "Dock", "type": "method" }, { "name": "getActivePaneItem", "text": "getActivePaneItem()", "snippet": null, "description": "Get the active {Pane}'s active item.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getActivePaneItem", "leftLabel": "Object", "type": "method" }, { "name": "getActiveTextEditor", "text": "getActiveTextEditor()", "snippet": null, "description": "Get the workspace center's active item if it is a {TextEditor}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getActiveTextEditor", "leftLabel": "TextEditor", "type": "method" }, { "name": "getBottomDock", "text": "getBottomDock()", "snippet": null, "description": "Get the {Dock} below the editor window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getBottomDock", "type": "method" }, { "name": "getBottomPanels", "text": "getBottomPanels()", "snippet": null, "description": "Get an {Array} of all the panel items at the bottom of the editor window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getBottomPanels", "type": "method" }, { "name": "getCenter", "text": "getCenter()", "snippet": null, "description": "Get the {WorkspaceCenter} at the center of the editor window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getCenter", "type": "method" }, { "name": "getFooterPanels", "text": "getFooterPanels()", "snippet": null, "description": "Get an {Array} of all the panel items in the footer.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getFooterPanels", "type": "method" }, { "name": "getHeaderPanels", "text": "getHeaderPanels()", "snippet": null, "description": "Get an {Array} of all the panel items in the header.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getHeaderPanels", "type": "method" }, { "name": "getLeftDock", "text": "getLeftDock()", "snippet": null, "description": "Get the {Dock} to the left of the editor window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getLeftDock", "type": "method" }, { "name": "getLeftPanels", "text": "getLeftPanels()", "snippet": null, "description": "Get an {Array} of all the panel items to the left of the editor window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getLeftPanels", "type": "method" }, { "name": "getModalPanels", "text": "getModalPanels()", "snippet": null, "description": "Get an {Array} of all the modal panel items", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getModalPanels", "type": "method" }, { "name": "getPaneItems", "text": "getPaneItems()", "snippet": null, "description": "Get all pane items in the workspace.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getPaneItems", "leftLabel": "Array", "type": "method" }, { "name": "getPanes", "text": "getPanes()", "snippet": null, "description": "Get all panes in the workspace.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getPanes", "leftLabel": "Array", "type": "method" }, { "name": "getRightDock", "text": "getRightDock()", "snippet": null, "description": "Get the {Dock} to the right of the editor window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getRightDock", "type": "method" }, { "name": "getRightPanels", "text": "getRightPanels()", "snippet": null, "description": "Get an {Array} of all the panel items to the right of the editor window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getRightPanels", "type": "method" }, { "name": "getTextEditors", "text": "getTextEditors()", "snippet": null, "description": "Get all text editors in the workspace.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getTextEditors", "leftLabel": "Array", "type": "method" }, { "name": "getTopPanels", "text": "getTopPanels()", "snippet": null, "description": "Get an {Array} of all the panel items at the top of the editor window.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-getTopPanels", "type": "method" }, { "name": "hide", "text": null, "snippet": "hide(${1:itemOrURI})", "description": "Search the workspace for items matching the given URI and hide them.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-hide", "leftLabel": "Boolean", "type": "method" }, { "name": "isTextEditor", "text": null, "snippet": "isTextEditor(${1:object})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-isTextEditor", "leftLabel": "Boolean", "type": "method" }, { "name": "observeActivePane", "text": null, "snippet": "observeActivePane(${1:callback})", "description": "Invoke the given callback with the current active pane and when\nthe active pane changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-observeActivePane", "leftLabel": "Disposable", "type": "method" }, { "name": "observeActivePaneItem", "text": null, "snippet": "observeActivePaneItem(${1:callback})", "description": "Invoke the given callback with the current active pane item and\nwith all future active pane items in the workspace.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-observeActivePaneItem", "leftLabel": "Disposable", "type": "method" }, { "name": "observeActiveTextEditor", "text": null, "snippet": "observeActiveTextEditor(${1:callback})", "description": "Invoke the given callback with the current active text editor\n(if any), with all future active text editors, and when there is no longer\nan active text editor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-observeActiveTextEditor", "leftLabel": "Disposable", "type": "method" }, { "name": "observePaneItems", "text": null, "snippet": "observePaneItems(${1:callback})", "description": "Invoke the given callback with all current and future panes items\nin the workspace.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-observePaneItems", "leftLabel": "Disposable", "type": "method" }, { "name": "observePanes", "text": null, "snippet": "observePanes(${1:callback})", "description": "Invoke the given callback with all current and future panes in the\nworkspace.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-observePanes", "leftLabel": "Disposable", "type": "method" }, { "name": "observeTextEditors", "text": null, "snippet": "observeTextEditors(${1:callback})", "description": "Invoke the given callback with all current and future text\neditors in the workspace.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-observeTextEditors", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidAddPane", "text": null, "snippet": "onDidAddPane(${1:callback})", "description": "Invoke the given callback when a pane is added to the workspace.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-onDidAddPane", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidAddPaneItem", "text": null, "snippet": "onDidAddPaneItem(${1:callback})", "description": "Invoke the given callback when a pane item is added to the\nworkspace.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-onDidAddPaneItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidAddTextEditor", "text": null, "snippet": "onDidAddTextEditor(${1:callback})", "description": "Invoke the given callback when a text editor is added to the\nworkspace.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-onDidAddTextEditor", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeActivePane", "text": null, "snippet": "onDidChangeActivePane(${1:callback})", "description": "Invoke the given callback when the active pane changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-onDidChangeActivePane", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeActivePaneItem", "text": null, "snippet": "onDidChangeActivePaneItem(${1:callback})", "description": "Invoke the given callback when the active pane item changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-onDidChangeActivePaneItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeActiveTextEditor", "text": null, "snippet": "onDidChangeActiveTextEditor(${1:callback})", "description": "Invoke the given callback when a text editor becomes the active\ntext editor and when there is no longer an active text editor.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-onDidChangeActiveTextEditor", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroyPane", "text": null, "snippet": "onDidDestroyPane(${1:callback})", "description": "Invoke the given callback when a pane is destroyed in the\nworkspace.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-onDidDestroyPane", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroyPaneItem", "text": null, "snippet": "onDidDestroyPaneItem(${1:callback})", "description": "Invoke the given callback when a pane item is destroyed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-onDidDestroyPaneItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidOpen", "text": null, "snippet": "onDidOpen(${1:callback})", "description": "Invoke the given callback whenever an item is opened. Unlike\n{::onDidAddPaneItem}, observers will be notified for items that are already\npresent in the workspace when they are reopened.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-onDidOpen", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidStopChangingActivePaneItem", "text": null, "snippet": "onDidStopChangingActivePaneItem(${1:callback})", "description": "Invoke the given callback when the active pane item stops\nchanging.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-onDidStopChangingActivePaneItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onWillDestroyPane", "text": null, "snippet": "onWillDestroyPane(${1:callback})", "description": "Invoke the given callback before a pane is destroyed in the\nworkspace.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-onWillDestroyPane", "leftLabel": "Disposable", "type": "method" }, { "name": "onWillDestroyPaneItem", "text": null, "snippet": "onWillDestroyPaneItem(${1:callback})", "description": "Invoke the given callback when a pane item is about to be\ndestroyed, before the user is prompted to save it.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-onWillDestroyPaneItem", "leftLabel": "Disposable", "type": "method" }, { "name": "open", "text": null, "snippet": "open(${1:uri}, ${2:options})", "description": "Opens the given URI in Atom asynchronously.\nIf the URI is already open, the existing item for that URI will be\nactivated. If no URI is given, or no registered opener can open\nthe URI, a new empty {TextEditor} will be created.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-open", "leftLabel": "Promise", "type": "method" }, { "name": "paneContainerForItem", "text": null, "snippet": "paneContainerForItem(${1:item})", "description": "Get the first pane container that contains the given item.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-paneContainerForItem", "leftLabel": "Dock", "type": "method" }, { "name": "paneContainerForURI", "text": null, "snippet": "paneContainerForURI(${1:uri})", "description": "Get the first pane container that contains an item with the given\nURI.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-paneContainerForURI", "leftLabel": "Dock", "type": "method" }, { "name": "paneForItem", "text": null, "snippet": "paneForItem(${1:item})", "description": "Get the {Pane} containing the given item.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-paneForItem", "leftLabel": "Pane", "type": "method" }, { "name": "paneForURI", "text": null, "snippet": "paneForURI(${1:uri})", "description": "Get the first {Pane} that contains an item with the given URI.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-paneForURI", "leftLabel": "Pane", "type": "method" }, { "name": "panelForItem", "text": null, "snippet": "panelForItem(${1:item})", "description": "", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-panelForItem", "leftLabel": "Panel", "type": "method" }, { "name": "reopenItem", "text": "reopenItem()", "snippet": null, "description": "Asynchronously reopens the last-closed item's URI if it hasn't already been\nreopened.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-reopenItem", "leftLabel": "Promise", "type": "method" }, { "name": "replace", "text": null, "snippet": "replace(${1:regex}, ${2:replacementText}, ${3:filePaths}, ${4:iterator})", "description": "Performs a replace across all the specified files in the project.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-replace", "leftLabel": "Promise", "type": "method" }, { "name": "scan", "text": null, "snippet": "scan(${1:regex}, ${2:options}, ${3:iterator})", "description": "Performs a search across all files in the workspace.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-scan", "leftLabel": "Promise", "type": "method" }, { "name": "toggle", "text": null, "snippet": "toggle(${1:itemOrURI})", "description": "Search the workspace for items matching the given URI. If any are found, hide them.\nOtherwise, open the URL.", "descriptionMoreURL": "https://atom.io/docs/api/latest/Workspace#instance-toggle", "leftLabel": null, "type": "method" } ], "WorkspaceCenter": [ { "name": "activateNextPane", "text": "activateNextPane()", "snippet": null, "description": "Make the next pane active.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-activateNextPane", "type": "method" }, { "name": "activatePreviousPane", "text": "activatePreviousPane()", "snippet": null, "description": "Make the previous pane active.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-activatePreviousPane", "type": "method" }, { "name": "getActivePane", "text": "getActivePane()", "snippet": null, "description": "Get the active {Pane}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-getActivePane", "leftLabel": "Pane", "type": "method" }, { "name": "getActivePaneItem", "text": "getActivePaneItem()", "snippet": null, "description": "Get the active {Pane}'s active item.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-getActivePaneItem", "leftLabel": "Object", "type": "method" }, { "name": "getActiveTextEditor", "text": "getActiveTextEditor()", "snippet": null, "description": "Get the active item if it is an {TextEditor}.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-getActiveTextEditor", "leftLabel": "TextEditor", "type": "method" }, { "name": "getPaneItems", "text": "getPaneItems()", "snippet": null, "description": "Get all pane items in the workspace center.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-getPaneItems", "leftLabel": "Array", "type": "method" }, { "name": "getPanes", "text": "getPanes()", "snippet": null, "description": "Get all panes in the workspace center.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-getPanes", "leftLabel": "Array", "type": "method" }, { "name": "getTextEditors", "text": "getTextEditors()", "snippet": null, "description": "Get all text editors in the workspace center.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-getTextEditors", "leftLabel": "Array", "type": "method" }, { "name": "observeActivePane", "text": null, "snippet": "observeActivePane(${1:callback})", "description": "Invoke the given callback with the current active pane and when\nthe active pane changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-observeActivePane", "leftLabel": "Disposable", "type": "method" }, { "name": "observeActivePaneItem", "text": null, "snippet": "observeActivePaneItem(${1:callback})", "description": "Invoke the given callback with the current active pane item and\nwith all future active pane items in the workspace center.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-observeActivePaneItem", "leftLabel": "Disposable", "type": "method" }, { "name": "observePaneItems", "text": null, "snippet": "observePaneItems(${1:callback})", "description": "Invoke the given callback with all current and future panes items\nin the workspace center.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-observePaneItems", "leftLabel": "Disposable", "type": "method" }, { "name": "observePanes", "text": null, "snippet": "observePanes(${1:callback})", "description": "Invoke the given callback with all current and future panes in the\nworkspace center.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-observePanes", "leftLabel": "Disposable", "type": "method" }, { "name": "observeTextEditors", "text": null, "snippet": "observeTextEditors(${1:callback})", "description": "Invoke the given callback with all current and future text\neditors in the workspace center.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-observeTextEditors", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidAddPane", "text": null, "snippet": "onDidAddPane(${1:callback})", "description": "Invoke the given callback when a pane is added to the workspace\ncenter.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-onDidAddPane", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidAddPaneItem", "text": null, "snippet": "onDidAddPaneItem(${1:callback})", "description": "Invoke the given callback when a pane item is added to the\nworkspace center.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-onDidAddPaneItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidAddTextEditor", "text": null, "snippet": "onDidAddTextEditor(${1:callback})", "description": "Invoke the given callback when a text editor is added to the\nworkspace center.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-onDidAddTextEditor", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeActivePane", "text": null, "snippet": "onDidChangeActivePane(${1:callback})", "description": "Invoke the given callback when the active pane changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-onDidChangeActivePane", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidChangeActivePaneItem", "text": null, "snippet": "onDidChangeActivePaneItem(${1:callback})", "description": "Invoke the given callback when the active pane item changes.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-onDidChangeActivePaneItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroyPane", "text": null, "snippet": "onDidDestroyPane(${1:callback})", "description": "Invoke the given callback when a pane is destroyed in the\nworkspace center.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-onDidDestroyPane", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidDestroyPaneItem", "text": null, "snippet": "onDidDestroyPaneItem(${1:callback})", "description": "Invoke the given callback when a pane item is destroyed.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-onDidDestroyPaneItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onDidStopChangingActivePaneItem", "text": null, "snippet": "onDidStopChangingActivePaneItem(${1:callback})", "description": "Invoke the given callback when the active pane item stops\nchanging.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-onDidStopChangingActivePaneItem", "leftLabel": "Disposable", "type": "method" }, { "name": "onWillDestroyPane", "text": null, "snippet": "onWillDestroyPane(${1:callback})", "description": "Invoke the given callback before a pane is destroyed in the\nworkspace center.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-onWillDestroyPane", "leftLabel": "Disposable", "type": "method" }, { "name": "onWillDestroyPaneItem", "text": null, "snippet": "onWillDestroyPaneItem(${1:callback})", "description": "Invoke the given callback when a pane item is about to be\ndestroyed, before the user is prompted to save it.", "descriptionMoreURL": "https://atom.io/docs/api/latest/WorkspaceCenter#instance-onWillDestroyPaneItem", "leftLabel": "Disposable", "type": "method" } ] }