mirror of
https://github.com/Foundry376/Mailspring.git
synced 2025-01-01 13:14:16 +08:00
112 lines
3.4 KiB
HTML
112 lines
3.4 KiB
HTML
---
|
|
layout: docs
|
|
title: WorkspaceStore
|
|
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/workspace-store.coffee"
|
|
---
|
|
|
|
<h2>Summary</h2>
|
|
|
|
<div class="markdown-from-sourecode">
|
|
<p><p>The WorkspaceStore manages Sheets and layout modes in the application.
|
|
Observing the WorkspaceStore makes it easy to monitor the sheet stack. To learn
|
|
more about sheets and layout in N1, see the <a href='InterfaceConcepts.html'>Interface Concepts</a>
|
|
documentation.</p>
|
|
</p>
|
|
</div>
|
|
|
|
<ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Instance Methods</h3>
|
|
|
|
<h4 id=topSheet class="function-name">
|
|
topSheet(<span class="args"></span>) <a href="#topSheet" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p></p>
|
|
</div>
|
|
|
|
|
|
<strong>Returns</strong>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Return Values</th>
|
|
</tr>
|
|
<tr><td class="markdown-from-sourecode"><p>Returns The top {Sheet} in the current stack. Use this method to determine
|
|
the sheet the user is looking at.</p>
|
|
</td></tr>
|
|
</table>
|
|
<h4 id=rootSheet class="function-name">
|
|
rootSheet(<span class="args"></span>) <a href="#rootSheet" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p></p>
|
|
</div>
|
|
|
|
|
|
<strong>Returns</strong>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Return Values</th>
|
|
</tr>
|
|
<tr><td class="markdown-from-sourecode"><p>Returns The {Sheet} at the root of the current stack.</p>
|
|
</td></tr>
|
|
</table>
|
|
<h4 id=sheetStack class="function-name">
|
|
sheetStack(<span class="args"></span>) <a href="#sheetStack" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p></p>
|
|
</div>
|
|
|
|
|
|
<strong>Returns</strong>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Return Values</th>
|
|
</tr>
|
|
<tr><td class="markdown-from-sourecode"><p>Returns an {Array<Sheet>} The stack of sheets</p>
|
|
</td></tr>
|
|
</table>
|
|
<h4 id=hiddenLocations class="function-name">
|
|
hiddenLocations(<span class="args"></span>) <a href="#hiddenLocations" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p></p>
|
|
</div>
|
|
|
|
|
|
<strong>Returns</strong>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Return Values</th>
|
|
</tr>
|
|
<tr><td class="markdown-from-sourecode"><p>Returns an <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/array'>Array</a> of locations that have been hidden.</p>
|
|
</td></tr>
|
|
</table>
|
|
<h4 id=isLocationHidden class="function-name">
|
|
isLocationHidden(<span class="args"></span>) <a href="#isLocationHidden" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p></p>
|
|
</div>
|
|
|
|
|
|
<strong>Returns</strong>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Return Values</th>
|
|
</tr>
|
|
<tr><td class="markdown-from-sourecode"><p>Returns a <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean'>Boolean</a> indicating whether the location provided is hidden.
|
|
You should provide one of the WorkspaceStore.Location constant values.</p>
|
|
</td></tr>
|
|
</table>
|