Represents options for a specific decoration in a {@link TextEditorDecorationType decoration set}.
Represents options for a specific decoration in a {@link TextEditorDecorationType decoration set}.
(hover-message decoration-options)
A message that should be rendered when hovering over the decoration.
Returns: MarkdownString | MarkedString | (MarkdownString | MarkedString)[] | undefined
A message that should be rendered when hovering over the decoration. **Returns:** `MarkdownString | MarkedString | (MarkdownString | MarkedString)[] | undefined`
(range decoration-options)
Range to which this decoration is applied. The range must not be empty.
Returns: Range
Range to which this decoration is applied. The range must not be empty. **Returns:** `Range`
(render-options decoration-options)
Render options applied to the current decoration. For performance reasons, keep the number of decoration specific options small, and use decoration types wherever possible.
Returns: DecorationInstanceRenderOptions | undefined
Render options applied to the current decoration. For performance reasons, keep the number of decoration specific options small, and use decoration types wherever possible. **Returns:** `DecorationInstanceRenderOptions | undefined`
(set-hover-message! decoration-options value)
A message that should be rendered when hovering over the decoration.
A message that should be rendered when hovering over the decoration.
(set-range! decoration-options value)
Range to which this decoration is applied. The range must not be empty.
Range to which this decoration is applied. The range must not be empty.
(set-render-options! decoration-options value)
Render options applied to the current decoration. For performance reasons, keep the number of decoration specific options small, and use decoration types wherever possible.
Render options applied to the current decoration. For performance reasons, keep the number of decoration specific options small, and use decoration types wherever possible.
cljdoc builds & hosts documentation for Clojure/Script libraries
Ctrl+k | Jump to recent docs |
← | Move to previous article |
→ | Move to next article |
Ctrl+/ | Jump to the search field |