text-buffer
Version:
A container for large mutable strings with annotated regions
1,053 lines (1,052 loc) • 217 kB
JSON
{
"classes": {
"DisplayMarkerLayer": {
"name": "DisplayMarkerLayer",
"filename": "src/display-marker-layer.coffee",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker-layer.coffee#L11",
"sections": [
{
"name": "Lifecycle",
"description": ""
},
{
"name": "Event Subscription",
"description": ""
},
{
"name": "Marker creation",
"description": ""
},
{
"name": "Querying",
"description": ""
}
],
"classMethods": [],
"instanceMethods": [
{
"name": "destroy",
"sectionName": "Lifecycle",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker-layer.coffee#L27",
"visibility": "Essential",
"summary": "Destroy this layer. ",
"description": "Destroy this layer. "
},
{
"name": "clear",
"sectionName": "Lifecycle",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker-layer.coffee#L39",
"visibility": "Public",
"summary": "Destroy all markers in this layer. ",
"description": "Destroy all markers in this layer. "
},
{
"name": "isDestroyed",
"sectionName": "Lifecycle",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker-layer.coffee#L49",
"visibility": "Essential",
"summary": "Determine whether this layer has been destroyed.",
"description": "Determine whether this layer has been destroyed.",
"returnValues": [
{
"type": "Boolean",
"description": "Returns a {Boolean}."
}
]
},
{
"name": "onDidDestroy",
"sectionName": "Event Subscription",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker-layer.coffee#L59",
"visibility": "Public",
"summary": "Subscribe to be notified synchronously when this layer is destroyed.",
"description": "Subscribe to be notified synchronously when this layer is destroyed.",
"returnValues": [
{
"type": "Disposable",
"description": "Returns a {Disposable}."
}
]
},
{
"name": "onDidUpdate",
"sectionName": "Event Subscription",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker-layer.coffee#L77",
"visibility": "Public",
"summary": "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.*",
"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.*\n\nSubscribers are notified once, asynchronously when any number of changes\noccur in a given tick of the event loop. You should re-query the layer\nto determine the state of markers in which you're interested in. It may\nbe counter-intuitive, but this is much more efficient than subscribing to\nevents on individual markers, which are expensive to deliver.",
"arguments": [
{
"name": "callback",
"description": "A {Function} that will be called with no arguments when changes occur on this layer.",
"type": "Function",
"isOptional": false
}
],
"returnValues": [
{
"type": "Disposable",
"description": "Returns a {Disposable}."
}
]
},
{
"name": "onDidCreateMarker",
"sectionName": "Event Subscription",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker-layer.coffee#L91",
"visibility": "Public",
"summary": "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.*",
"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.*\n\nYou should prefer {::onDidUpdate} when synchronous notifications aren't\nabsolutely necessary.",
"arguments": [
{
"name": "callback",
"description": "A {Function} that will be called with a {TextEditorMarker} whenever a new marker is created.",
"type": "Function",
"isOptional": false
}
],
"returnValues": [
{
"type": "Disposable",
"description": "Returns a {Disposable}."
}
]
},
{
"name": "markScreenRange",
"sectionName": "Marker creation",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker-layer.coffee#L133",
"visibility": "Public",
"summary": "Create a marker with the given screen range.",
"description": "Create a marker with the given screen range.",
"arguments": [
{
"name": "range",
"description": "A {Range} or range-compatible {Array}",
"type": "Range",
"isOptional": false
},
{
"children": [
{
"name": "reversed",
"description": "{Boolean} Creates the marker in a reversed orientation. (default: false)",
"type": "Boolean",
"isOptional": true
},
{
"name": "invalidate",
"description": "{String} Determines the rules by which changes to the buffer *invalidate* the marker. (default: 'overlap') It can be any of the following strategies, in order of fragility:\n* __never__: The marker is never marked as invalid. This is a good choice for\n markers representing selections in an editor.\n* __surround__: The marker is invalidated by changes that completely surround it.\n* __overlap__: The marker is invalidated by changes that surround the\n start or end of the marker. This is the default.\n* __inside__: The marker is invalidated by changes that extend into the\n inside of the marker. Changes that end at the marker's start or\n start at the marker's end do not invalidate the marker.\n* __touch__: The marker is invalidated by a change that touches the marked\n region in any way, including changes that end at the marker's\n start or start at the marker's end. This is the most fragile strategy.",
"type": "String",
"isOptional": true
},
{
"name": "exclusive",
"description": "{Boolean} indicating whether insertions at the start or end of the marked range should be interpreted as happening *outside* the marker. Defaults to `false`, except when using the `inside` invalidation strategy or when when the marker has no tail, in which case it defaults to true. Explicitly assigning this option overrides behavior in all circumstances.",
"type": "Boolean",
"isOptional": false
},
{
"name": "clipDirection",
"description": "{String} If `'backward'`, returns the first valid position preceding an invalid position. If `'forward'`, returns the first valid position following an invalid position. If `'closest'`, returns the first valid position closest to an invalid position. Defaults to `'closest'`. Applies to the start and end of the given range.",
"type": "String",
"isOptional": false
}
],
"name": "options",
"description": "A hash of key-value pairs to associate with the marker. There are also reserved property names that have marker-specific meaning.",
"type": null,
"isOptional": false
}
],
"returnValues": [
{
"type": "DisplayMarker",
"description": "Returns a {DisplayMarker}."
}
]
},
{
"name": "markScreenPosition",
"sectionName": "Marker creation",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker-layer.coffee#L170",
"visibility": "Public",
"summary": "Create a marker on this layer with its head at the given screen\nposition and no tail.",
"description": "Create a marker on this layer with its head at the given screen\nposition and no tail.",
"arguments": [
{
"name": "screenPosition",
"description": "A {Point} or point-compatible {Array}",
"type": "Point",
"isOptional": false
},
{
"children": [
{
"name": "invalidate",
"description": "{String} Determines the rules by which changes to the buffer *invalidate* the marker. (default: 'overlap') It can be any of the following strategies, in order of fragility:\n* __never__: The marker is never marked as invalid. This is a good choice for\n markers representing selections in an editor.\n* __surround__: The marker is invalidated by changes that completely surround it.\n* __overlap__: The marker is invalidated by changes that surround the\n start or end of the marker. This is the default.\n* __inside__: The marker is invalidated by changes that extend into the\n inside of the marker. Changes that end at the marker's start or\n start at the marker's end do not invalidate the marker.\n* __touch__: The marker is invalidated by a change that touches the marked\n region in any way, including changes that end at the marker's\n start or start at the marker's end. This is the most fragile strategy.",
"type": "String",
"isOptional": true
},
{
"name": "exclusive",
"description": "{Boolean} indicating whether insertions at the start or end of the marked range should be interpreted as happening *outside* the marker. Defaults to `false`, except when using the `inside` invalidation strategy or when when the marker has no tail, in which case it defaults to true. Explicitly assigning this option overrides behavior in all circumstances.",
"type": "Boolean",
"isOptional": false
},
{
"name": "clipDirection",
"description": "{String} If `'backward'`, returns the first valid position preceding an invalid position. If `'forward'`, returns the first valid position following an invalid position. If `'closest'`, returns the first valid position closest to an invalid position. Defaults to `'closest'`.",
"type": "String",
"isOptional": false
}
],
"name": "options",
"description": "An {Object} with the following keys:",
"type": "Object",
"isOptional": true
}
],
"returnValues": [
{
"type": "DisplayMarker",
"description": "Returns a {DisplayMarker}."
}
]
},
{
"name": "markBufferRange",
"sectionName": "Marker creation",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker-layer.coffee#L204",
"visibility": "Public",
"summary": "Create a marker with the given buffer range.",
"description": "Create a marker with the given buffer range.",
"arguments": [
{
"name": "range",
"description": "A {Range} or range-compatible {Array}",
"type": "Range",
"isOptional": false
},
{
"children": [
{
"name": "reversed",
"description": "{Boolean} Creates the marker in a reversed orientation. (default: false)",
"type": "Boolean",
"isOptional": true
},
{
"name": "invalidate",
"description": "{String} Determines the rules by which changes to the buffer *invalidate* the marker. (default: 'overlap') It can be any of the following strategies, in order of fragility:\n* __never__: The marker is never marked as invalid. This is a good choice for\n markers representing selections in an editor.\n* __surround__: The marker is invalidated by changes that completely surround it.\n* __overlap__: The marker is invalidated by changes that surround the\n start or end of the marker. This is the default.\n* __inside__: The marker is invalidated by changes that extend into the\n inside of the marker. Changes that end at the marker's start or\n start at the marker's end do not invalidate the marker.\n* __touch__: The marker is invalidated by a change that touches the marked\n region in any way, including changes that end at the marker's\n start or start at the marker's end. This is the most fragile strategy.",
"type": "String",
"isOptional": true
},
{
"name": "exclusive",
"description": "{Boolean} indicating whether insertions at the start or end of the marked range should be interpreted as happening *outside* the marker. Defaults to `false`, except when using the `inside` invalidation strategy or when when the marker has no tail, in which case it defaults to true. Explicitly assigning this option overrides behavior in all circumstances.",
"type": "Boolean",
"isOptional": false
}
],
"name": "options",
"description": "A hash of key-value pairs to associate with the marker. There are also reserved property names that have marker-specific meaning.",
"type": null,
"isOptional": false
}
],
"returnValues": [
{
"type": "DisplayMarker",
"description": "Returns a {DisplayMarker}."
}
]
},
{
"name": "markBufferPosition",
"sectionName": "Marker creation",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker-layer.coffee#L235",
"visibility": "Public",
"summary": "Create a marker on this layer with its head at the given buffer\nposition and no tail.",
"description": "Create a marker on this layer with its head at the given buffer\nposition and no tail.",
"arguments": [
{
"name": "bufferPosition",
"description": "A {Point} or point-compatible {Array}",
"type": "Point",
"isOptional": false
},
{
"children": [
{
"name": "invalidate",
"description": "{String} Determines the rules by which changes to the buffer *invalidate* the marker. (default: 'overlap') It can be any of the following strategies, in order of fragility:\n* __never__: The marker is never marked as invalid. This is a good choice for\n markers representing selections in an editor.\n* __surround__: The marker is invalidated by changes that completely surround it.\n* __overlap__: The marker is invalidated by changes that surround the\n start or end of the marker. This is the default.\n* __inside__: The marker is invalidated by changes that extend into the\n inside of the marker. Changes that end at the marker's start or\n start at the marker's end do not invalidate the marker.\n* __touch__: The marker is invalidated by a change that touches the marked\n region in any way, including changes that end at the marker's\n start or start at the marker's end. This is the most fragile strategy.",
"type": "String",
"isOptional": true
},
{
"name": "exclusive",
"description": "{Boolean} indicating whether insertions at the start or end of the marked range should be interpreted as happening *outside* the marker. Defaults to `false`, except when using the `inside` invalidation strategy or when when the marker has no tail, in which case it defaults to true. Explicitly assigning this option overrides behavior in all circumstances.",
"type": "Boolean",
"isOptional": false
}
],
"name": "options",
"description": "An {Object} with the following keys:",
"type": "Object",
"isOptional": true
}
],
"returnValues": [
{
"type": "DisplayMarker",
"description": "Returns a {DisplayMarker}."
}
]
},
{
"name": "getMarker",
"sectionName": "Querying",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker-layer.coffee#L245",
"visibility": "Essential",
"summary": "Get an existing marker by its id.",
"description": "Get an existing marker by its id.",
"returnValues": [
{
"type": "DisplayMarker",
"description": "Returns a {DisplayMarker}."
}
]
},
{
"name": "getMarkers",
"sectionName": "Querying",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker-layer.coffee#L254",
"visibility": "Essential",
"summary": "Get all markers in the layer.",
"description": "Get all markers in the layer.",
"returnValues": [
{
"type": "Array",
"description": "Returns an {Array} of {DisplayMarker}s."
}
]
},
{
"name": "getMarkerCount",
"sectionName": "Querying",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker-layer.coffee#L260",
"visibility": "Public",
"summary": "Get the number of markers in the marker layer.",
"description": "Get the number of markers in the marker layer.",
"returnValues": [
{
"type": "Number",
"description": "Returns a {Number}."
}
]
},
{
"name": "findMarkers",
"sectionName": "Querying",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker-layer.coffee#L298",
"visibility": "Public",
"summary": "Find markers in the layer conforming to the given parameters.",
"description": "Find markers in the layer conforming to the given parameters.\n\nThis method finds markers based on the given properties. Markers can be\nassociated with custom properties that will be compared with basic equality.\nIn addition, there are several special properties that will be compared\nwith the range of the markers rather than their properties.",
"arguments": [
{
"children": [
{
"name": "startBufferPosition",
"description": "Only include markers starting at this {Point} in buffer coordinates.",
"type": "Point",
"isOptional": false
},
{
"name": "endBufferPosition",
"description": "Only include markers ending at this {Point} in buffer coordinates.",
"type": "Point",
"isOptional": false
},
{
"name": "startScreenPosition",
"description": "Only include markers starting at this {Point} in screen coordinates.",
"type": "Point",
"isOptional": false
},
{
"name": "endScreenPosition",
"description": "Only include markers ending at this {Point} in screen coordinates.",
"type": "Point",
"isOptional": false
},
{
"name": "startsInBufferRange",
"description": "Only include markers starting inside this {Range} in buffer coordinates.",
"type": "Range",
"isOptional": false
},
{
"name": "endsInBufferRange",
"description": "Only include markers ending inside this {Range} in buffer coordinates.",
"type": "Range",
"isOptional": false
},
{
"name": "startsInScreenRange",
"description": "Only include markers starting inside this {Range} in screen coordinates.",
"type": "Range",
"isOptional": false
},
{
"name": "endsInScreenRange",
"description": "Only include markers ending inside this {Range} in screen coordinates.",
"type": "Range",
"isOptional": false
},
{
"name": "startBufferRow",
"description": "Only include markers starting at this row in buffer coordinates.",
"type": null,
"isOptional": false
},
{
"name": "endBufferRow",
"description": "Only include markers ending at this row in buffer coordinates.",
"type": null,
"isOptional": false
},
{
"name": "startScreenRow",
"description": "Only include markers starting at this row in screen coordinates.",
"type": null,
"isOptional": false
},
{
"name": "endScreenRow",
"description": "Only include markers ending at this row in screen coordinates.",
"type": null,
"isOptional": false
},
{
"name": "intersectsBufferRowRange",
"description": "Only include markers intersecting this {Array} of `[startRow, endRow]` in buffer coordinates.",
"type": "Array",
"isOptional": false
},
{
"name": "intersectsScreenRowRange",
"description": "Only include markers intersecting this {Array} of `[startRow, endRow]` in screen coordinates.",
"type": "Array",
"isOptional": false
},
{
"name": "containsBufferRange",
"description": "Only include markers containing this {Range} in buffer coordinates.",
"type": "Range",
"isOptional": false
},
{
"name": "containsBufferPosition",
"description": "Only include markers containing this {Point} in buffer coordinates.",
"type": "Point",
"isOptional": false
},
{
"name": "containedInBufferRange",
"description": "Only include markers contained in this {Range} in buffer coordinates.",
"type": "Range",
"isOptional": false
},
{
"name": "containedInScreenRange",
"description": "Only include markers contained in this {Range} in screen coordinates.",
"type": "Range",
"isOptional": false
},
{
"name": "intersectsBufferRange",
"description": "Only include markers intersecting this {Range} in buffer coordinates.",
"type": "Range",
"isOptional": false
},
{
"name": "intersectsScreenRange",
"description": "Only include markers intersecting this {Range} in screen coordinates.",
"type": "Range",
"isOptional": false
}
],
"name": "properties",
"description": "An {Object} containing properties that each returned marker must satisfy. Markers can be associated with custom properties, which are compared with basic equality. In addition, several reserved properties can be used to filter markers based on their current range:",
"type": "Object",
"isOptional": false
}
],
"returnValues": [
{
"type": "Array",
"description": "Returns an {Array} of {DisplayMarker}s"
}
]
}
],
"classProperties": [],
"instanceProperties": [],
"visibility": "Public",
"summary": "*Experimental:* A container for a related set of markers at the\n{DisplayLayer} level. Wraps an underlying {MarkerLayer} on the {TextBuffer}.",
"description": "*Experimental:* A container for a related set of markers at the\n{DisplayLayer} level. Wraps an underlying {MarkerLayer} on the {TextBuffer}.\n\nThis API is experimental and subject to change on any release. "
},
"DisplayMarker": {
"name": "DisplayMarker",
"filename": "src/display-marker.coffee",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L43",
"sections": [
{
"name": "Construction and Destruction",
"description": ""
},
{
"name": "Event Subscription",
"description": ""
},
{
"name": "TextEditorMarker Details",
"description": ""
},
{
"name": "Comparing to other markers",
"description": ""
},
{
"name": "Managing the marker's range",
"description": ""
}
],
"classMethods": [],
"instanceMethods": [
{
"name": "destroy",
"sectionName": "Construction and Destruction",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L56",
"visibility": "Essential",
"summary": "Destroys the marker, causing it to emit the 'destroyed' event. Once\ndestroyed, a marker cannot be restored by undo/redo operations. ",
"description": "Destroys the marker, causing it to emit the 'destroyed' event. Once\ndestroyed, a marker cannot be restored by undo/redo operations. "
},
{
"name": "copy",
"sectionName": "Construction and Destruction",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L81",
"visibility": "Essential",
"summary": "Creates and returns a new {DisplayMarker} with the same properties as\nthis marker.",
"description": "Creates and returns a new {DisplayMarker} with the same properties as\nthis marker.\n\n{Selection} markers (markers with a custom property `type: \"selection\"`)\nshould be copied with a different `type` value, for example with\n`marker.copy({type: null})`. Otherwise, the new marker's selection will\nbe merged with this marker's selection, and a `null` value will be\nreturned.",
"arguments": [
{
"name": "properties",
"description": "{Object} properties to associate with the new marker. The new marker's properties are computed by extending this marker's properties with `properties`.",
"type": "Object",
"isOptional": true
}
],
"returnValues": [
{
"type": "DisplayMarker",
"description": "Returns a {DisplayMarker}."
}
]
},
{
"name": "onDidChange",
"sectionName": "Event Subscription",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L110",
"visibility": "Essential",
"summary": "Invoke the given callback when the state of the marker changes.",
"description": "Invoke the given callback when the state of the marker changes.",
"arguments": [
{
"children": [
{
"children": [
{
"name": "oldHeadBufferPosition",
"description": "{Point} representing the former head buffer position",
"type": "Point",
"isOptional": false
},
{
"name": "newHeadBufferPosition",
"description": "{Point} representing the new head buffer position",
"type": "Point",
"isOptional": false
},
{
"name": "oldTailBufferPosition",
"description": "{Point} representing the former tail buffer position",
"type": "Point",
"isOptional": false
},
{
"name": "newTailBufferPosition",
"description": "{Point} representing the new tail buffer position",
"type": "Point",
"isOptional": false
},
{
"name": "oldHeadScreenPosition",
"description": "{Point} representing the former head screen position",
"type": "Point",
"isOptional": false
},
{
"name": "newHeadScreenPosition",
"description": "{Point} representing the new head screen position",
"type": "Point",
"isOptional": false
},
{
"name": "oldTailScreenPosition",
"description": "{Point} representing the former tail screen position",
"type": "Point",
"isOptional": false
},
{
"name": "newTailScreenPosition",
"description": "{Point} representing the new tail screen position",
"type": "Point",
"isOptional": false
},
{
"name": "wasValid",
"description": "{Boolean} indicating whether the marker was valid before the change",
"type": "Boolean",
"isOptional": false
},
{
"name": "isValid",
"description": "{Boolean} indicating whether the marker is now valid",
"type": "Boolean",
"isOptional": false
},
{
"name": "hadTail",
"description": "{Boolean} indicating whether the marker had a tail before the change",
"type": "Boolean",
"isOptional": false
},
{
"name": "hasTail",
"description": "{Boolean} indicating whether the marker now has a tail",
"type": "Boolean",
"isOptional": false
},
{
"name": "oldProperties",
"description": "{Object} containing the marker's custom properties before the change.",
"type": "Object",
"isOptional": false
},
{
"name": "newProperties",
"description": "{Object} containing the marker's custom properties after the change.",
"type": "Object",
"isOptional": false
},
{
"name": "textChanged",
"description": "{Boolean} indicating whether this change was caused by a textual change to the buffer or whether the marker was manipulated directly via its public API.",
"type": "Boolean",
"isOptional": false
}
],
"name": "event",
"description": "{Object} with the following keys:",
"type": "Object",
"isOptional": false
}
],
"name": "callback",
"description": "{Function} to be called when the marker changes.",
"type": "Function",
"isOptional": false
}
],
"returnValues": [
{
"type": "Disposable",
"description": "Returns a {Disposable} on which `.dispose()` can be called to unsubscribe."
}
]
},
{
"name": "onDidDestroy",
"sectionName": "Event Subscription",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L126",
"visibility": "Essential",
"summary": "Invoke the given callback when the marker is destroyed.",
"description": "Invoke the given callback when the marker is destroyed.",
"arguments": [
{
"name": "callback",
"description": "{Function} to be called when the marker is destroyed.",
"type": "Function",
"isOptional": false
}
],
"returnValues": [
{
"type": "Disposable",
"description": "Returns a {Disposable} on which `.dispose()` can be called to unsubscribe."
}
]
},
{
"name": "isValid",
"sectionName": "TextEditorMarker Details",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L137",
"visibility": "Essential",
"summary": "",
"description": "",
"returnValues": [
{
"type": "Boolean",
"description": "Returns a {Boolean} indicating whether the marker is valid.\nMarkers can be invalidated when a region surrounding them in the buffer is\nchanged."
}
]
},
{
"name": "isDestroyed",
"sectionName": "TextEditorMarker Details",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L145",
"visibility": "Essential",
"summary": "",
"description": "",
"returnValues": [
{
"type": "Boolean",
"description": "Returns a {Boolean} indicating whether the marker has been\ndestroyed. A marker can be invalid without being destroyed, in which case\nundoing the invalidating operation would restore the marker. Once a marker\nis destroyed by calling {DisplayMarker::destroy}, no undo/redo operation\ncan ever bring it back."
}
]
},
{
"name": "isReversed",
"sectionName": "TextEditorMarker Details",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L149",
"visibility": "Essential",
"summary": "",
"description": "",
"returnValues": [
{
"type": "Boolean",
"description": "Returns a {Boolean} indicating whether the head precedes the tail."
}
]
},
{
"name": "isExclusive",
"sectionName": "TextEditorMarker Details",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L154",
"visibility": "Essential",
"summary": "",
"description": "",
"returnValues": [
{
"type": "Boolean",
"description": "Returns a {Boolean} indicating whether changes that occur exactly\nat the marker's head or tail cause it to move."
}
]
},
{
"name": "getInvalidationStrategy",
"sectionName": "TextEditorMarker Details",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L162",
"visibility": "Essential",
"summary": "Get the invalidation strategy for this marker.",
"description": "Get the invalidation strategy for this marker.\n\nValid values include: `never`, `surround`, `overlap`, `inside`, and `touch`.",
"returnValues": [
{
"type": "String",
"description": "Returns a {String}."
}
]
},
{
"name": "getProperties",
"sectionName": "TextEditorMarker Details",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L167",
"visibility": "Essential",
"summary": "",
"description": "",
"returnValues": [
{
"type": "Object",
"description": "Returns an {Object} containing any custom properties associated with\nthe marker."
}
]
},
{
"name": "setProperties",
"sectionName": "TextEditorMarker Details",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L174",
"visibility": "Essential",
"summary": "Merges an {Object} containing new properties into the marker's\nexisting properties.",
"description": "Merges an {Object} containing new properties into the marker's\nexisting properties.",
"arguments": [
{
"name": "properties",
"description": "{Object} ",
"type": "Object",
"isOptional": false
}
]
},
{
"name": "matchesProperties",
"sectionName": "TextEditorMarker Details",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L179",
"visibility": "Essential",
"summary": "",
"description": "",
"returnValues": [
{
"type": null,
"description": "Returns whether this marker matches the given parameters. The\nparameters are the same as {DisplayMarkerLayer::findMarkers}."
}
]
},
{
"name": "compare",
"sectionName": "Comparing to other markers",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L192",
"visibility": "Essential",
"summary": "Compares this marker to another based on their ranges.",
"description": "Compares this marker to another based on their ranges.",
"arguments": [
{
"name": "other",
"description": "{DisplayMarker}",
"type": "DisplayMarker",
"isOptional": false
}
],
"returnValues": [
{
"type": "Number",
"description": "Returns a {Number}"
}
]
},
{
"name": "isEqual",
"sectionName": "Comparing to other markers",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L199",
"visibility": "Essential",
"summary": "",
"description": "\n\n",
"arguments": [
{
"name": "other",
"description": "{DisplayMarker} other marker ",
"type": "DisplayMarker",
"isOptional": false
}
],
"returnValues": [
{
"type": "Boolean",
"description": "Returns a {Boolean} indicating whether this marker is equivalent to\nanother marker, meaning they have the same range and options."
}
]
},
{
"name": "getBufferRange",
"sectionName": "Managing the marker's range",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L210",
"visibility": "Essential",
"summary": "Gets the buffer range of this marker.",
"description": "Gets the buffer range of this marker.",
"returnValues": [
{
"type": "Range",
"description": "Returns a {Range}."
}
]
},
{
"name": "getScreenRange",
"sectionName": "Managing the marker's range",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L216",
"visibility": "Essential",
"summary": "Gets the screen range of this marker.",
"description": "Gets the screen range of this marker.",
"returnValues": [
{
"type": "Range",
"description": "Returns a {Range}."
}
]
},
{
"name": "setBufferRange",
"sectionName": "Managing the marker's range",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L224",
"visibility": "Essential",
"summary": "Modifies the buffer range of this marker.",
"description": "Modifies the buffer range of this marker.",
"arguments": [
{
"name": "bufferRange",
"description": "The new {Range} to use",
"type": "Range",
"isOptional": false
},
{
"children": [
{
"name": "reversed",
"description": "{Boolean} If true, the marker will to be in a reversed orientation. ",
"type": "Boolean",
"isOptional": false
}
],
"name": "properties",
"description": "{Object} properties to associate with the marker.",
"type": "Object",
"isOptional": true
}
]
},
{
"name": "setScreenRange",
"sectionName": "Managing the marker's range",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L237",
"visibility": "Essential",
"summary": "Modifies the screen range of this marker.",
"description": "Modifies the screen range of this marker.",
"arguments": [
{
"name": "screenRange",
"description": "The new {Range} to use",
"type": "Range",
"isOptional": false
},
{
"children": [
{
"name": "reversed",
"description": "{Boolean} If true, the marker will to be in a reversed orientation.",
"type": "Boolean",
"isOptional": false
},
{
"name": "clipDirection",
"description": "{String} If `'backward'`, returns the first valid position preceding an invalid position. If `'forward'`, returns the first valid position following an invalid position. If `'closest'`, returns the first valid position closest to an invalid position. Defaults to `'closest'`. Applies to the start and end of the given range. ",
"type": "String",
"isOptional": false
}
],
"name": "options",
"description": "An {Object} with the following keys:",
"type": "Object",
"isOptional": true
}
]
},
{
"name": "getHeadBufferPosition",
"sectionName": "Managing the marker's range",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L243",
"visibility": "Extended",
"summary": "Retrieves the buffer position of the marker's head.",
"description": "Retrieves the buffer position of the marker's head.",
"returnValues": [
{
"type": "Point",
"description": "Returns a {Point}."
}
]
},
{
"name": "setHeadBufferPosition",
"sectionName": "Managing the marker's range",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L249",
"visibility": "Extended",
"summary": "Sets the buffer position of the marker's head.",
"description": "Sets the buffer position of the marker's head.",
"arguments": [
{
"name": "bufferPosition",
"description": "The new {Point} to use ",
"type": "Point",
"isOptional": false
}
]
},
{
"name": "getHeadScreenPosition",
"sectionName": "Managing the marker's range",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L262",
"visibility": "Extended",
"summary": "Retrieves the screen position of the marker's head.",
"description": "Retrieves the screen position of the marker's head.",
"arguments": [
{
"children": [
{
"name": "clipDirection",
"description": "{String} If `'backward'`, returns the first valid position preceding an invalid position. If `'forward'`, returns the first valid position following an invalid position. If `'closest'`, returns the first valid position closest to an invalid position. Defaults to `'closest'`. Applies to the start and end of the given range.",
"type": "String",
"isOptional": false
}
],
"name": "options",
"description": "An {Object} with the following keys:",
"type": "Object",
"isOptional": true
}
],
"returnValues": [
{
"type": "Point",
"description": "Returns a {Point}."
}
]
},
{
"name": "setHeadScreenPosition",
"sectionName": "Managing the marker's range",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L274",
"visibility": "Extended",
"summary": "Sets the screen position of the marker's head.",
"description": "Sets the screen position of the marker's head.",
"arguments": [
{
"name": "screenPosition",
"description": "The new {Point} to use",
"type": "Point",
"isOptional": false
},
{
"children": [
{
"name": "clipDirection",
"description": "{String} If `'backward'`, returns the first valid position preceding an invalid position. If `'forward'`, returns the first valid position following an invalid position. If `'closest'`, returns the first valid position closest to an invalid position. Defaults to `'closest'`. Applies to the start and end of the given range. ",
"type": "String",
"isOptional": false
}
],
"name": "options",
"description": "An {Object} with the following keys:",
"type": "Object",
"isOptional": true
}
]
},
{
"name": "getTailBufferPosition",
"sectionName": "Managing the marker's range",
"srcUrl": "https://github.com/atom/text-buffer/blob/v13.18.6/src/display-marker.coffee#L280",
"visibility": "Extended",
"summary": "Retrieves the buffer position of the marker's tail.",
"description": "Retrieves the buffer position of the marker's tail.",
"returnValues": [
{