mirror of
https://github.com/laurent22/joplin.git
synced 2025-01-08 13:06:15 +02:00
538 lines
28 KiB
HTML
538 lines
28 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>Joplin Plugin API Documentation</title>
|
|
<meta name="description" content="Documentation for Joplin Plugin API Documentation">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="assets/css/main.css">
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="classes/joplin.html" class="title">Joplin Plugin API Documentation</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<!--
|
|
<li>
|
|
<a href="globals.html">Globals</a>
|
|
</li>
|
|
-->
|
|
</ul>
|
|
<h1><!-- -->Joplin Plugin API Documentation</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Enumerations</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-enum"><a href="enums/contentscripttype.html" class="tsd-kind-icon">Content<wbr>Script<wbr>Type</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/filesystemitem.html" class="tsd-kind-icon">File<wbr>System<wbr>Item</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/importmoduleoutputformat.html" class="tsd-kind-icon">Import<wbr>Module<wbr>Output<wbr>Format</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/itemchangeeventtype.html" class="tsd-kind-icon">Item<wbr>Change<wbr>Event<wbr>Type</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/menuitemlocation.html" class="tsd-kind-icon">Menu<wbr>Item<wbr>Location</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/settingitemtype.html" class="tsd-kind-icon">Setting<wbr>Item<wbr>Type</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/toolbarbuttonlocation.html" class="tsd-kind-icon">Toolbar<wbr>Button<wbr>Location</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Classes</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-class"><a href="classes/joplin.html" class="tsd-kind-icon">Joplin</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/joplincommands.html" class="tsd-kind-icon">Joplin<wbr>Commands</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/joplincontentscripts.html" class="tsd-kind-icon">Joplin<wbr>Content<wbr>Scripts</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/joplindata.html" class="tsd-kind-icon">Joplin<wbr>Data</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/joplininterop.html" class="tsd-kind-icon">Joplin<wbr>Interop</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/joplinplugins.html" class="tsd-kind-icon">Joplin<wbr>Plugins</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/joplinsettings.html" class="tsd-kind-icon">Joplin<wbr>Settings</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/joplinviews.html" class="tsd-kind-icon">Joplin<wbr>Views</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/joplinviewsdialogs.html" class="tsd-kind-icon">Joplin<wbr>Views<wbr>Dialogs</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/joplinviewsmenuitems.html" class="tsd-kind-icon">Joplin<wbr>Views<wbr>Menu<wbr>Items</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/joplinviewsmenus.html" class="tsd-kind-icon">Joplin<wbr>Views<wbr>Menus</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/joplinviewspanels.html" class="tsd-kind-icon">Joplin<wbr>Views<wbr>Panels</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/joplinviewstoolbarbuttons.html" class="tsd-kind-icon">Joplin<wbr>Views<wbr>Toolbar<wbr>Buttons</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/joplinworkspace.html" class="tsd-kind-icon">Joplin<wbr>Workspace</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Interfaces</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-interface"><a href="interfaces/buttonspec.html" class="tsd-kind-icon">Button<wbr>Spec</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/changeevent.html" class="tsd-kind-icon">Change<wbr>Event</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/command.html" class="tsd-kind-icon">Command</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/contentscriptcontext.html" class="tsd-kind-icon">Content<wbr>Script<wbr>Context</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/createmenuitemoptions.html" class="tsd-kind-icon">Create<wbr>Menu<wbr>Item<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/dialogresult.html" class="tsd-kind-icon">Dialog<wbr>Result</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/disposable.html" class="tsd-kind-icon">Disposable</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/editorcommand.html" class="tsd-kind-icon">Editor<wbr>Command</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/exportcontext.html" class="tsd-kind-icon">Export<wbr>Context</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/exportmodule.html" class="tsd-kind-icon">Export<wbr>Module</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/exportoptions.html" class="tsd-kind-icon">Export<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/importcontext.html" class="tsd-kind-icon">Import<wbr>Context</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/importmodule.html" class="tsd-kind-icon">Import<wbr>Module</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/itemchangeevent.html" class="tsd-kind-icon">Item<wbr>Change<wbr>Event</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/menuitem.html" class="tsd-kind-icon">Menu<wbr>Item</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/script.html" class="tsd-kind-icon">Script</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/settingitem.html" class="tsd-kind-icon">Setting<wbr>Item</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/settingsection.html" class="tsd-kind-icon">Setting<wbr>Section</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/syncstartevent.html" class="tsd-kind-icon">Sync<wbr>Start<wbr>Event</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Type aliases</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#buttonid" class="tsd-kind-icon">Button<wbr>Id</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#changehandler" class="tsd-kind-icon">Change<wbr>Handler</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#itemchangehandler" class="tsd-kind-icon">Item<wbr>Change<wbr>Handler</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#path" class="tsd-kind-icon">Path</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#postmessagehandler" class="tsd-kind-icon">Post<wbr>Message<wbr>Handler</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#syncstarthandler" class="tsd-kind-icon">Sync<wbr>Start<wbr>Handler</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#viewhandle" class="tsd-kind-icon">View<wbr>Handle</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Variables</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-variable"><a href="globals.html#logger" class="tsd-kind-icon">logger</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Functions</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-function"><a href="globals.html#iscontextmenuitemlocation" class="tsd-kind-icon">is<wbr>Context<wbr>Menu<wbr>Item<wbr>Location</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Type aliases</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="buttonid" class="tsd-anchor"></a>
|
|
<h3>Button<wbr>Id</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Button<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="changehandler" class="tsd-anchor"></a>
|
|
<h3>Change<wbr>Handler</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Change<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="interfaces/changeevent.html" class="tsd-signature-type">ChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="interfaces/changeevent.html" class="tsd-signature-type">ChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>event: <a href="interfaces/changeevent.html" class="tsd-signature-type">ChangeEvent</a></h5>
|
|
</li>
|
|
</ul>
|
|
<!-- JOPLINCHANGE
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
|
-->
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="itemchangehandler" class="tsd-anchor"></a>
|
|
<h3>Item<wbr>Change<wbr>Handler</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Item<wbr>Change<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="interfaces/itemchangeevent.html" class="tsd-signature-type">ItemChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="interfaces/itemchangeevent.html" class="tsd-signature-type">ItemChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>event: <a href="interfaces/itemchangeevent.html" class="tsd-signature-type">ItemChangeEvent</a></h5>
|
|
</li>
|
|
</ul>
|
|
<!-- JOPLINCHANGE
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
|
-->
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="path" class="tsd-anchor"></a>
|
|
<h3>Path</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>An array of at least one element and at most three elements.</p>
|
|
</div>
|
|
<ul>
|
|
<li><strong>[0]</strong>: Resource name (eg. "notes", "folders", "tags", etc.)</li>
|
|
<li><strong>[1]</strong>: (Optional) Resource ID.</li>
|
|
<li><strong>[2]</strong>: (Optional) Resource link.</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="postmessagehandler" class="tsd-anchor"></a>
|
|
<h3>Post<wbr>Message<wbr>Handler</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Post<wbr>Message<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>id: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>message: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
</ul>
|
|
<!-- JOPLINCHANGE
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
|
|
|
-->
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="syncstarthandler" class="tsd-anchor"></a>
|
|
<h3>Sync<wbr>Start<wbr>Handler</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Sync<wbr>Start<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="interfaces/syncstartevent.html" class="tsd-signature-type">SyncStartEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="interfaces/syncstartevent.html" class="tsd-signature-type">SyncStartEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>event: <a href="interfaces/syncstartevent.html" class="tsd-signature-type">SyncStartEvent</a></h5>
|
|
</li>
|
|
</ul>
|
|
<!-- JOPLINCHANGE
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
|
-->
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="viewhandle" class="tsd-anchor"></a>
|
|
<h3>View<wbr>Handle</h3>
|
|
<div class="tsd-signature tsd-kind-icon">View<wbr>Handle<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Variables</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="logger" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> logger</h3>
|
|
<div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LoggerWrapper</span><span class="tsd-signature-symbol"> = Logger.create('joplin.plugins')</span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Functions</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="iscontextmenuitemlocation" class="tsd-anchor"></a>
|
|
<h3>is<wbr>Context<wbr>Menu<wbr>Item<wbr>Location</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Context<wbr>Menu<wbr>Item<wbr>Location<span class="tsd-signature-symbol">(</span>location<span class="tsd-signature-symbol">: </span><a href="enums/menuitemlocation.html" class="tsd-signature-type">MenuItemLocation</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>location: <a href="enums/menuitemlocation.html" class="tsd-signature-type">MenuItemLocation</a></h5>
|
|
</li>
|
|
</ul>
|
|
<!-- JOPLINCHANGE
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
|
|
|
|
-->
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<!--
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class="globals current ">
|
|
<a href="globals.html"><em>Globals</em></a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
-->
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/contentscripttype.html" class="tsd-kind-icon">ContentScriptType</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/filesystemitem.html" class="tsd-kind-icon">FileSystemItem</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/importmoduleoutputformat.html" class="tsd-kind-icon">ImportModuleOutputFormat</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/itemchangeeventtype.html" class="tsd-kind-icon">ItemChangeEventType</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/menuitemlocation.html" class="tsd-kind-icon">MenuItemLocation</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/settingitemtype.html" class="tsd-kind-icon">SettingItemType</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/toolbarbuttonlocation.html" class="tsd-kind-icon">ToolbarButtonLocation</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/joplin.html" class="tsd-kind-icon">joplin</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/joplincommands.html" class="tsd-kind-icon">joplin.commands</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/joplincontentscripts.html" class="tsd-kind-icon">joplin.contentScripts</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/joplindata.html" class="tsd-kind-icon">joplin.data</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/joplininterop.html" class="tsd-kind-icon">joplin.interop</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/joplinplugins.html" class="tsd-kind-icon">joplin.plugins</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/joplinsettings.html" class="tsd-kind-icon">joplin.settings</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/joplinviews.html" class="tsd-kind-icon">joplin.views</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/joplinviewsdialogs.html" class="tsd-kind-icon">joplin.views.dialogs</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/joplinviewstoolbarbuttons.html" class="tsd-kind-icon">joplin.views.toolbarButtons</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/joplinworkspace.html" class="tsd-kind-icon">joplin.workspace</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/buttonspec.html" class="tsd-kind-icon">ButtonSpec</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/changeevent.html" class="tsd-kind-icon">ChangeEvent</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/command.html" class="tsd-kind-icon">Command</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/contentscriptcontext.html" class="tsd-kind-icon">ContentScriptContext</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/createmenuitemoptions.html" class="tsd-kind-icon">CreateMenuItemOptions</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/dialogresult.html" class="tsd-kind-icon">DialogResult</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/disposable.html" class="tsd-kind-icon">Disposable</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/editorcommand.html" class="tsd-kind-icon">EditorCommand</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/exportcontext.html" class="tsd-kind-icon">ExportContext</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/exportmodule.html" class="tsd-kind-icon">ExportModule</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/exportoptions.html" class="tsd-kind-icon">ExportOptions</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/importcontext.html" class="tsd-kind-icon">ImportContext</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/itemchangeevent.html" class="tsd-kind-icon">ItemChangeEvent</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/script.html" class="tsd-kind-icon">Script</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/settingitem.html" class="tsd-kind-icon">SettingItem</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/settingsection.html" class="tsd-kind-icon">SettingSection</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/syncstartevent.html" class="tsd-kind-icon">SyncStartEvent</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#buttonid" class="tsd-kind-icon">ButtonId</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#changehandler" class="tsd-kind-icon">ChangeHandler</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#itemchangehandler" class="tsd-kind-icon">ItemChangeHandler</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#path" class="tsd-kind-icon">Path</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#postmessagehandler" class="tsd-kind-icon">PostMessageHandler</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#syncstarthandler" class="tsd-kind-icon">SyncStartHandler</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#viewhandle" class="tsd-kind-icon">ViewHandle</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#iscontextmenuitemlocation" class="tsd-kind-icon">isContextMenuItemLocation</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<!-- JOPLINCHANGE
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
-->
|
|
<div class="overlay"></div>
|
|
<script src="assets/js/main.js"></script>
|
|
</body>
|
|
</html> |