• Packages
  • Themes
  • Documentation
  • Blog
  • Discuss
Sign in
Whoops, there was an error
v1.34.0
v1.33.1
v1.33.0
v1.32.2
v1.32.1
v1.32.0
v1.31.2
v1.31.1
v1.31.0
v1.30.0
v1.29.0
v1.28.2
v1.28.1
v1.28.0
untagged-688de6479cca05b51c00
untagged-2abd5a23b4430027c837
v1.27.2
v1.27.1
v1.27.0
v1.26.1
v1.26.0
v1.25.1
v1.25.0
v1.24.1
v1.24.0
v1.23.3
v1.23.2
v1.23.1
v1.23.0
v1.22.1
v1.22.0
v1.21.2
v1.21.1
v1.21.0
v1.20.1
v1.20.0
v1.19.7
v1.19.6
v1.19.5
v1.19.4
v1.19.3
v1.19.2
v1.19.1
v1.19.0
v1.18.0
v1.17.2
v1.17.1
v1.17.0
v1.16.0
v1.15.0
v1.14.4
v1.14.3
v1.14.2
v1.14.1
v1.14.0
v1.13.1
v1.13.0
v1.12.9
v1.12.8
v1.12.7
v1.12.6
v1.12.5
v1.12.4
v1.12.3
v1.12.2
v1.12.1
v1.12.0
v1.11.2
v1.11.1
v1.11.0
v1.10.2
v1.10.1
v1.10.0
v1.9.9
v1.9.8
v1.9.7
v1.9.6
v1.9.5
v1.9.4
v1.9.3
v1.9.2
v1.9.1
v1.9.0
v1.8.0
v1.7.4
v1.7.3
v1.7.2
v1.7.1
v1.7.0
v1.6.2
v1.6.1
v1.6.0
v1.5.4
v1.5.3
v1.5.2
v1.5.1
v1.5.0
v1.4.3
v1.4.2
v1.4.1
v1.4.0
v1.3.3
v1.3.2
v1.3.1
v1.3.0
v1.2.4
v1.2.3
v1.2.2
v1.2.1
v1.2.0
v1.1.0
v1.0.19
v1.0.18
v1.0.17
v1.0.16
v1.0.15
v1.0.14
v1.0.13
v1.0.12
v1.0.11
v1.0.10
v1.0.9
v1.0.8
v1.0.7
v1.0.6
v1.0.5
v1.0.4
v1.0.3
v1.0.2
v1.0.1
v1.0.0
v0.211.0
v0.210.0
v0.209.0
v0.208.0
v0.207.0
v0.206.0
v0.205.0
v0.204.0
v0.203.0
v0.202.0
v0.201.0
v0.200.0
v0.199.0
v0.198.0
v0.197.0
v0.196.0
v0.195.0
v0.194.0
v0.193.0
v0.192.0
v0.191.0
v0.190.0
v0.189.0
v0.188.0
v0.187.0
Loading…

Essential Classes

  • AtomEnvironment
  • Color
  • CommandRegistry
  • CompositeDisposable
  • Config
  • Decoration
  • DisplayMarker
  • DisplayMarkerLayer
  • Disposable
  • Emitter
  • LayerDecoration
  • MarkerLayer
  • Notification
  • NotificationManager
  • Point
  • Range
  • TextEditor
  • TooltipManager
  • ViewRegistry
  • Workspace
  • WorkspaceCenter

Extended Classes

  • BufferedNodeProcess
  • BufferedProcess
  • Clipboard
  • ContextMenuManager
  • Cursor
  • DeserializerManager
  • Directory
  • Dock
  • File
  • GitRepository
  • Grammar
  • GrammarRegistry
  • Gutter
  • HistoryManager
  • KeymapManager
  • MenuManager
  • Package
  • PackageManager
  • Pane
  • Panel
  • PathWatcher
  • Project
  • ScopeDescriptor
  • Selection
  • StyleManager
  • Task
  • TextBuffer
  • ThemeManager

Point essential

Represents a point in a buffer in row/column coordinates.

Every public method that takes a point also accepts a point-compatible Array. This means a 2-element array containing Numbers representing the row and column. So the following are equivalent:

new Point(1, 2)
[1, 2] # Point compatible Array 

Properties

::row

A zero-indexed Number representing the row of the Point.

::column

A zero-indexed Number representing the column of the Point.

Construction

.fromObject(object, copy)

Convert any point-compatible object to a Point.

Argument Description
object

This can be an object that's already a Point, in which case it's simply returned, or an array containing two Numbers representing the row and column.

copy

An optional boolean indicating whether to force the copying of objects that are already points.

Return values

Returns: A Point based on the given object.

::constructor(row, column)

Construct a Point object

Argument Description
row

Number row

column

Number column

::copy()

Return values

Returns a new Point with the same row and column.

::negate()

Return values

Returns a new Point with the row and column negated.

Comparison

.min(point1, point2)

Argument Description
point1

Point

point2

Point

Return values

Returns the given Point that is earlier in the buffer.

::compare(other)

Argument Description
other

A Point or point-compatible Array.

Return values

Returns -1 if this point precedes the argument.

Returns 0 if this point is equivalent to the argument.

Returns 1 if this point follows the argument.

::isEqual(other)

Argument Description
other

A Point or point-compatible Array.

Return values

Returns a Boolean indicating whether this point has the same row and column as the given Point or point-compatible Array.

::isLessThan(other)

Argument Description
other

A Point or point-compatible Array.

Return values

Returns a Boolean indicating whether this point precedes the given Point or point-compatible Array.

::isLessThanOrEqual(other)

Argument Description
other

A Point or point-compatible Array.

Return values

Returns a Boolean indicating whether this point precedes or is equal to the given Point or point-compatible Array.

::isGreaterThan(other)

Argument Description
other

A Point or point-compatible Array.

Return values

Returns a Boolean indicating whether this point follows the given Point or point-compatible Array.

::isGreaterThanOrEqual(other)

Argument Description
other

A Point or point-compatible Array.

Return values

Returns a Boolean indicating whether this point follows or is equal to the given Point or point-compatible Array.

Operations

::freeze()

Makes this point immutable and returns itself.

Return values

Returns an immutable version of this Point

::translate(other)

Build and return a new point by adding the rows and columns of the given point.

Argument Description
other

A Point whose row and column will be added to this point's row and column to build the returned point.

Return values

Returns a Point.

::traverse(other)

Build and return a new Point by traversing the rows and columns specified by the given point.

This method differs from the direct, vector-style addition offered by ::translate. Rather than adding the rows and columns directly, it derives the new point from traversing in "typewriter space". At the end of every row traversed, a carriage return occurs that returns the columns to 0 before continuing the traversal.

Argument Description
other

A Point providing the rows and columns to traverse by.

Return values

Returns a Point.

Conversion

::toArray()

Return values

Returns an array of this point's row and column.

::serialize()

Return values

Returns an array of this point's row and column.

::toString()

Return values

Returns a string representation of the point.

  • Terms of Use
  • Privacy
  • Code of Conduct
  • Releases
  • FAQ
  • Contact
with by