profectus-docs/assets/api_wrappers_marks_mark_functions_addMark.md.BfAT0Prd.lean.js

1 line
2.2 KiB
JavaScript
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as a,c as r,a0 as t,o as n}from"./chunks/framework.P9qPzDnn.js";const m=JSON.parse('{"title":"Function: addMark()","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/wrappers/marks/mark/functions/addMark.md","filePath":"api/wrappers/marks/mark/functions/addMark.md","lastUpdated":null}'),o={name:"api/wrappers/marks/mark/functions/addMark.md"};function s(i,e,d,c,p,l){return n(),r("div",null,e[0]||(e[0]=[t('<p><a href="./../../../../">Profectus</a> / <a href="./../">wrappers/marks/mark</a> / addMark</p><h1 id="function-addmark" tabindex="-1">Function: addMark() <a class="header-anchor" href="#function-addmark" aria-label="Permalink to &quot;Function: addMark()&quot;"></a></h1><blockquote><p><strong>addMark</strong>(<code>element</code>, <code>optionsFunc</code>): <code>asserts element is VueFeature &amp; { mark: Mark }</code></p></blockquote><p>Creates a mark to the top left of the given element with the given options.</p><h2 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;"></a></h2><h3 id="element" tabindex="-1">element <a class="header-anchor" href="#element" aria-label="Permalink to &quot;element&quot;"></a></h3><p><a href="./../../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a></p><p>The renderable feature to display the tooltip on.</p><h3 id="optionsfunc" tabindex="-1">optionsFunc <a class="header-anchor" href="#optionsfunc" aria-label="Permalink to &quot;optionsFunc&quot;"></a></h3><p>() =&gt; <a href="./../interfaces/MarkOptions"><code>MarkOptions</code></a></p><p>Mark options.</p><h2 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;"></a></h2><p><code>asserts element is VueFeature &amp; { mark: Mark }</code></p><h2 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;"></a></h2><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/wrappers/marks/mark.tsx#L25" target="_blank" rel="noreferrer">profectus/src/wrappers/marks/mark.tsx:25</a></p>',15)]))}const h=a(o,[["render",s]]);export{m as __pageData,h as default};