Skip to main content
Module

x/denops_std/function/mod.ts>sign_unplace

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

Remove a previously placed sign in one or more buffers. This is similar to the :sign-unplace command.

{group} is the sign group name. To use the global sign group, use an empty string. If {group} is set to '*', then all the groups including the global group are used. The signs in {group} are selected based on the entries in {dict}. The following optional entries in {dict} are supported: buffer buffer name or number. See bufname(). id sign identifier If {dict} is not supplied, then all the signs in {group} are removed.

Returns 0 on success and -1 on failure.

Examples:

" Remove sign 10 from buffer a.vim
call sign_unplace('', {'buffer' : "a.vim", 'id' : 10})

" Remove sign 20 in group 'g1' from buffer 3
call sign_unplace('g1', {'buffer' : 3, 'id' : 20})

" Remove all the signs in group 'g2' from buffer 10
call sign_unplace('g2', {'buffer' : 10})

" Remove sign 30 in group 'g3' from all the buffers
call sign_unplace('g3', {'id' : 30})

" Remove all the signs placed in buffer 5
call sign_unplace('*', {'buffer' : 5})

" Remove the signs in group 'g4' from all the buffers
call sign_unplace('g4')

" Remove sign 40 from all the buffers
call sign_unplace('*', {'id' : 40})

" Remove all the placed signs from all the buffers
call sign_unplace('*')

Can also be used as a method:

GetSigngroup()->sign_unplace()

Parameters

denops: Denops
group: unknown
optional
dict: unknown

Returns

Promise<number>