Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/denops_std/function/vim/mod.ts>popup_getoptions

📚 Standard module for denops.vim
Latest
function popup_getoptions
import { popup_getoptions } from "https://deno.land/x/denops_std@v6.5.0/function/vim/mod.ts";

Return the {options} for popup {id} in a Dict. A zero value means the option was not set. For "zindex" the default value is returned, not zero.

The "moved" entry is a list with line number, minimum and maximum column, [0, 0, 0] when not set.

The "mousemoved" entry is a list with screen row, minimum and maximum screen column, [0, 0, 0] when not set.

"firstline" is the property set on the popup, unlike the "firstline" obtained with popup_getpos() which is the actual buffer line at the top of the popup window.

"border" and "padding" are not included when all values are zero. When all values are one then an empty list is included.

"borderhighlight" is not included when all values are empty. "scrollbarhighlight" and "thumbhighlight" are only included when set.

"tabpage" will be -1 for a global popup, zero for a popup on the current tabpage and a positive number for a popup on another tabpage.

"textprop", "textpropid" and "textpropwin" are only present when "textprop" was set.

If popup window {id} is not found an empty Dict is returned.

Can also be used as a method:

GetPopup()->popup_getoptions()

Parameters

denops: Denops
id: unknown

Returns

Promise<Record<string, unknown>>