Home Explore Blog CI



neovim

39th chunk of `runtime/doc/api.txt`
74e0a7f07331ce20a232ac9cc15dc3b85a7f017100608e6a0000000100000fc6
 "blend": blend with background text color. Not supported
                      for "inline" virt_text.
                  • virt_lines : virtual lines to add next to this mark This
                    should be an array over lines, where each line in turn is
                    an array over `[text, highlight]` tuples. In general,
                    buffer and window options do not affect the display of the
                    text. In particular 'wrap' and 'linebreak' options do not
                    take effect, so the number of extra screen lines will
                    always match the size of the array. However the 'tabstop'
                    buffer option is still used for hard tabs. By default
                    lines are placed below the buffer line containing the
                    mark.
                  • virt_lines_above: place virtual lines above instead.
                  • virt_lines_leftcol: Place virtual lines in the leftmost
                    column of the window, bypassing sign and number columns.
                  • virt_lines_overflow: controls how to handle virtual lines
                    wider than the window. Currently takes the one of the
                    following values:
                    • "trunc": truncate virtual lines on the right (default).
                    • "scroll": virtual lines can scroll horizontally with
                      'nowrap', otherwise the same as "trunc".
                  • ephemeral : for use with |nvim_set_decoration_provider()|
                    callbacks. The mark will only be used for the current
                    redraw cycle, and not be permanently stored in the buffer.
                  • right_gravity : boolean that indicates the direction the
                    extmark will be shifted in when new text is inserted (true
                    for right, false for left). Defaults to true.
                  • end_right_gravity : boolean that indicates the direction
                    the extmark end position (if it exists) will be shifted in
                    when new text is inserted (true for right, false for
                    left). Defaults to false.
                  • undo_restore : Restore the exact position of the mark if
                    text around the mark was deleted and then restored by
                    undo. Defaults to true.
                  • invalidate : boolean that indicates whether to hide the
                    extmark if the entirety of its range is deleted. For
                    hidden marks, an "invalid" key is added to the "details"
                    array of |nvim_buf_get_extmarks()| and family. If
                    "undo_restore" is false, the extmark is deleted instead.
                  • priority: a priority value for the highlight group, sign
                    attribute or virtual text. For virtual text, item with
                    highest priority is drawn last. For example treesitter
                    highlighting uses a value of 100.
                  • strict: boolean that indicates extmark should not be
                    placed if the line or column value is past the end of the
                    buffer or end of the line respectively. Defaults to true.
                  • sign_text: string of length 1-2 used to display in the
                    sign column.
                  • sign_hl_group: highlight group used for the sign column
                    text.
                  • number_hl_group: highlight group used for the number
                    column.
                  • line_hl_group: highlight group used for the whole line.
                  • cursorline_hl_group: highlight group used for the sign
                    column text when the cursor is on the same line as the
                    mark and 'cursorline' is enabled.
                  • conceal: string which should be either empty or a single
                    character. Enable concealing similar to |:syn-conceal|.
  

Title: nvim_buf_set_extmark Optional Parameters (Concluding)
Summary
This section concludes the optional parameters for `nvim_buf_set_extmark`. It covers `virt_lines_overflow` options (trunc, scroll) for handling virtual lines wider than the window, `ephemeral` for temporary marks used in decoration providers, `right_gravity` and `end_right_gravity` to control extmark shifting on text insertion, `undo_restore` for restoring extmark positions after undo, and `invalidate` for hiding extmarks when their range is deleted. It also includes `priority` for highlight/virtual text ordering, `strict` for precise placement, `sign_text`, `sign_hl_group`, `number_hl_group`, `line_hl_group`, `cursorline_hl_group` for sign/number/line highlighting, and `conceal` for text concealing.