UNPKG

gojs

Version:

Interactive diagrams, charts, and graphs, such as trees, flowcharts, orgcharts, UML, BPMN, or business diagrams

568 lines (567 loc) 34.1 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>GoCloudStorageManager | GoJS API</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../../assets/css/bootstrap.min.css"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <!-- non-fixed navbar --> <nav id="non-fixed-nav" class="navbar navbar-inverse navbar-top"> <div class="container-fluid"> <div class="navbar-header"> <div class="navheader-container"> <div class="navheader-collapse" data-toggle="collapse" data-target="#navbar"> <a id="toplogo" class="navbar-brand" href="../../index.html">GoJS</a> <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> </div> </div> </div> <div id="navbar" class="navbar-collapse collapse"> <ul class="nav navbar-nav navbar-right"> <li><a href="../../index.html">Home</a></li> <li><a href="../../learn/index.html">Learn</a></li> <li><a href="../../samples/index.html">Samples</a></li> <li><a href="../../intro/index.html">Intro</a></li> <li><a href="../../api/index.html" target="api">API</a></li> <li><a href="https://www.nwoods.com/components/evalform.htm">Register</a></li> <li><a href="../../download.html">Download</a></li> <li><a href="https://forum.nwoods.com/c/gojs">Forum</a></li> <li><a href="https://www.nwoods.com/contact.html" onclick="ga('send','event','Outbound Link','click','contact');">Contact</a></li> <li class="buy"><a href="https://www.nwoods.com/sales/index.html" onclick="ga('send','event','Outbound Link','click','buy');">Buy</a></li> <li class="activate"><a href="https://www.nwoods.com/app/activate.aspx?sku=gojs">Activate</a></li> </ul> </div><!--/.nav-collapse --> </div> </nav> <div class="tsd-page-header"> <div class="tsd-page-toolbar"> <div class="container-fluid plr15"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" 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="../index.html" class="title">GoJS API</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> </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-fluid plr15"> <div class="top-copyright"> <!--<b>GoJS</b>&reg; Diagramming Components<br/>version &lt;br/&gt;version 2.1.18 for TypeScript/HTML<br/>by <a href="https://www.nwoods.com/">Northwoods Software&reg;</a>--> <b>GoJS</b>&reg; Diagramming Components<br/>version 2.1.18<br/>by <a href="https://www.nwoods.com/">Northwoods Software&reg;</a> </div> <div> <h1>Class GoCloudStorageManager</h1> </div> </div> </div> </div> </header> <div class="container-fluid container-main plr15"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-extension"> <p> This is part of GoCloudStorage and not part of the main GoJS library. Storage can be found in the GoJS kit under the <code>projects</code> folder. See the <a href="../../intro/storage.html">Storage intro page</a> for more information. </p> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">GoCloudStorageManager</span> </li> </ul> </section> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <p>Class for easily saving / loading GoJS <a href="Model.html">Model</a>s to / from a user-defined set of Cloud Storage Services with a pre-defined UI.</p> <p>GoCloudStorageManager holds a set of <a href="GoCloudStorage.html">GoCloudStorage</a> subclass instances (<a href="GoCloudStorageManager.html#storages">storages</a>) to manage. When one is selected from the storage selection <a href="GoCloudStorageManager.html#menu">menu</a>, it becomes the <a href="GoCloudStorageManager.html#currentStorage">currentStorage</a> property, which is used to save / load / delete / create files.</p> </div> </section> <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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="GoCloudStorageManager.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="GoCloudStorageManager.html#currentStorage" class="tsd-kind-icon">current<wbr>Storage</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="GoCloudStorageManager.html#iconsRelativeDirectory" class="tsd-kind-icon">icons<wbr>Relative<wbr>Directory</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="GoCloudStorageManager.html#menu" class="tsd-kind-icon">menu</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="GoCloudStorageManager.html#storages" class="tsd-kind-icon">storages</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="GoCloudStorageManager.html#create" class="tsd-kind-icon">create</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="GoCloudStorageManager.html#getStorageIconPath" class="tsd-kind-icon">get<wbr>Storage<wbr>Icon<wbr>Path</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="GoCloudStorageManager.html#handleAction" class="tsd-kind-icon">handle<wbr>Action</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="GoCloudStorageManager.html#hideMenu" class="tsd-kind-icon">hide<wbr>Menu</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="GoCloudStorageManager.html#load" class="tsd-kind-icon">load</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="GoCloudStorageManager.html#remove" class="tsd-kind-icon">remove</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="GoCloudStorageManager.html#save" class="tsd-kind-icon">save</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="GoCloudStorageManager.html#selectStorageService" class="tsd-kind-icon">select<wbr>Storage<wbr>Service</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="GoCloudStorageManager.html#showMessage" class="tsd-kind-icon">show<wbr>Message</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3> constructor </h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>GoCloud<wbr>Storage<wbr>Manager<span class="tsd-signature-symbol">(</span>storages<span class="tsd-signature-symbol">: </span><a href="Set.html" class="tsd-signature-type">Set</a><span class="tsd-signature-symbol">&lt;</span><a href="GoCloudStorage.html" class="tsd-signature-type">GoCloudStorage</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="GoCloudStorage.html" class="tsd-signature-type">GoCloudStorage</a><span class="tsd-signature-symbol">&gt;</span>, iconsRelativeDirectory<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="GoCloudStorageManager.html" class="tsd-signature-type">GoCloudStorageManager</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>storages: <a href="Set.html" class="tsd-signature-type">Set</a><span class="tsd-signature-symbol">&lt;</span><a href="GoCloudStorage.html" class="tsd-signature-type">GoCloudStorage</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="GoCloudStorage.html" class="tsd-signature-type">GoCloudStorage</a><span class="tsd-signature-symbol">&gt;</span></h5> <div class="tsd-comment tsd-typography"> <p>Contains valid instances of <a href="GoCloudStorage.html">GoCloudStorage</a> subclasses. Use at most one instance of each subclass.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> iconsRelativeDirectory: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The directory path relative to the page in which this instance of GoCloudStorageManager exists, in which the storage service brand icons can be found. The default value is &quot;../goCloudStorageIcons/&quot;. <strong>Note:</strong> If this parameter is supplied, it is used as for the &quot;iconsRelativeDirectory&quot; constructor parameter for each instance this instance of GoCloudStorageManager manages in <a href="GoCloudStorageManager.html#storages">storages</a>.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="GoCloudStorageManager.html" class="tsd-signature-type">GoCloudStorageManager</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="currentStorage" class="tsd-anchor"></a> <h3> current<wbr>Storage <span class="tsd-signature-symbol">: </span><a href="GoCloudStorage.html" class="tsd-signature-type">GoCloudStorage</a> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get / set the <a href="GoCloudStorage.html">GoCloudStorage</a> subclass this instance of GoCloudStorageManager is actively managing.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="iconsRelativeDirectory" class="tsd-anchor"></a> <h3> icons<wbr>Relative<wbr>Directory <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get / set iconsRelativeDirectory, the directory path relative to the page in which this instance of GoCloudStorageManager exists, in which the storage service brand icons can be found. The default value is &quot;../goCloudStorageIcons/&quot;.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="menu" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagReadOnly">Read-only</span> menu <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get GoCloudStorageManager menu, from which a user chooses which storage service for this instance of GoCloudStorageManager to actively manage (see <a href="GoCloudStorageManager.html#currentStorage">currentStorage</a>). This is created (as a blank div) during construction. Its contents are populated during <a href="GoCloudStorageManager.html#selectStorageService">selectStorageService</a>.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="storages" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagReadOnly">Read-only</span> storages <span class="tsd-signature-symbol">: </span><a href="Set.html" class="tsd-signature-type">Set</a><span class="tsd-signature-symbol">&lt;</span><a href="GoCloudStorage.html" class="tsd-signature-type">GoCloudStorage</a><span class="tsd-signature-symbol">&gt;</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get storages (<a href="GoCloudStorage.html">GoCloudStorage</a> subclass instances) managed by an instance of GoCloudStorageManager. At most, there should be only one instance of each subclass. This is set with a parameter during construction.</p> </div> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="create" class="tsd-anchor"></a> <h3> create </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>saveBeforeCreate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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">&lt;</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Creates a new diagram with <a href="GoCloudStorageManager.html#currentStorage">currentStorage</a>&#39;s default model data (see <a href="GoCloudStorage.html#defaultModel">GoCloudStorage.defaultModel</a>. If currentStorage.isAutoSaving is true, prompt to save it to to currentStorage&#39;s storage service. if <a href="GoCloudStorageManager.html#currentStorage">currentStorage</a>&#39;s <a href="GoCloudStorage.html#isAutoSaving">GoCloudStorage.isAutoSaving</a> is true).</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> saveBeforeCreate: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></h5> <div class="tsd-comment tsd-typography"> <p>Whether or not to prompt the user to save their current work before creating a new diagram. See more at <a href="GoCloudStorage.html#create">GoCloudStorage.create</a>. Default value is false.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</span></h4> <p>Returns a Promise that resolves a <a href="DiagramFile.html">DiagramFile</a> representing the newly created file (if file was saved).</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getStorageIconPath" class="tsd-anchor"></a> <h3> get<wbr>Storage<wbr>Icon<wbr>Path </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Storage<wbr>Icon<wbr>Path<span class="tsd-signature-symbol">(</span>className<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get the path to the icon for a given <a href="GoCloudStorage.html#className">GoCloudStorage.className</a></p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>className: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="handleAction" class="tsd-anchor"></a> <h3> handle<wbr>Action </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">handle<wbr>Action<span class="tsd-signature-symbol">(</span>action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, saveBeforeCreate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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">&lt;</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Handle an action with the current <a href="GoCloudStorageManager.html#currentStorage">currentStorage</a>. Possible values for <code>action</code> can be:</p> <ul> <li>Load</li> <li>Save</li> <li>Save As</li> <li>Create</li> <li>Remove</li> </ul> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>action: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> saveBeforeCreate: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></h5> <div class="tsd-comment tsd-typography"> <p>Whether or not to prompt the user to save their current work before creating a new file. Default value is false. See more at <a href="GoCloudStorage.html#create">GoCloudStorage.create</a></p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="hideMenu" class="tsd-anchor"></a> <h3> hide<wbr>Menu </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">hide<wbr>Menu<span class="tsd-signature-symbol">(</span><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"> <div class="tsd-comment tsd-typography"> <p>Hide the storage selection <a href="GoCloudStorageManager.html#menu">menu</a></p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="load" class="tsd-anchor"></a> <h3> load </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</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">&lt;</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Launches the load interface for <a href="GoCloudStorageManager.html#currentStorage">currentStorage</a>.</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</span></h4> <p>Returns a Promise that resolves with a <a href="DiagramFile.html">DiagramFile</a> representing the loaded file.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="remove" class="tsd-anchor"></a> <h3> remove </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">remove<span class="tsd-signature-symbol">(</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">&lt;</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Launches the remove interface for <a href="GoCloudStorageManager.html#currentStorage">currentStorage</a>.</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</span></h4> <p>Returns a Promise that resolves with a <a href="DiagramFile.html">DiagramFile</a> representing the deleted file.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="save" class="tsd-anchor"></a> <h3> save </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">save<span class="tsd-signature-symbol">(</span>isSaveAs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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">&lt;</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Either launches the save interface for <a href="GoCloudStorageManager.html#currentStorage">currentStorage</a> or just saves the <a href="GoCloudStorage.html#managedDiagrams">GoCloudStorage.managedDiagrams</a>&#39; model data to storage at the path supplied in currentStorage&#39;s <a href="GoCloudStorage.html#currentDiagramFile">GoCloudStorage.currentDiagramFile</a>.path value, depending on a parameter.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> isSaveAs: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;true</span></h5> <div class="tsd-comment tsd-typography"> <p>If true, show the save interface for currentStorage. If false, save currentStorage&#39;s managedDiagrams&#39; model data to storage. Default value is true.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</span></h4> <p>Returns a Promise that resolves with a <a href="DiagramFile.html">DiagramFile</a> representing the saved file.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="selectStorageService" class="tsd-anchor"></a> <h3> select<wbr>Storage<wbr>Service </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">select<wbr>Storage<wbr>Service<span class="tsd-signature-symbol">(</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">&lt;</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Display options (<a href="GoCloudStorageManager.html#storages">storages</a>) supported by this instance of GoCloudStorageManager. Sets <a href="GoCloudStorageManager.html#currentStorage">currentStorage</a> to user&#39;s choice.</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</span></h4> <p>Returns a Promise that resolves with the new <a href="GoCloudStorageManager.html#currentStorage">currentStorage</a> instance</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="showMessage" class="tsd-anchor"></a> <h3> show<wbr>Message </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">show<wbr>Message<span class="tsd-signature-symbol">(</span>msg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, seconds<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><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"> <div class="tsd-comment tsd-typography"> <p>Display a message on the screen for a given number of seconds. Can be used for a variety of purposes, but a common one is to notify users when a file has been loaded / saved / deleted / created by handling the <a href="DiagramFile.html">DiagramFile</a> argument in the &quot;then&quot; function of returned Promises (from functions <a href="GoCloudStorageManager.html#load">load</a>, <a href="GoCloudStorageManager.html#create">create</a>, <a href="GoCloudStorageManager.html#save">save</a>, <a href="GoCloudStorageManager.html#remove">remove</a>) by displaying it as a message.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>msg: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Message to display</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> seconds: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>Number of seconds to display the message for. If no value is provided, the message will display for two seconds.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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 "> <a href="../index.html"><em>GoJS <wbr>Class <wbr>Index</em></a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-is-storage"> <a href="GoCloudStorageManager.html" class="tsd-kind-icon">Go<wbr>Cloud<wbr>Storage<wbr>Manager</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="GoCloudStorageManager.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="GoCloudStorageManager.html#currentStorage" class="tsd-kind-icon">current<wbr>Storage</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="GoCloudStorageManager.html#iconsRelativeDirectory" class="tsd-kind-icon">icons<wbr>Relative<wbr>Directory</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="GoCloudStorageManager.html#menu" class="tsd-kind-icon">menu</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="GoCloudStorageManager.html#storages" class="tsd-kind-icon">storages</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="GoCloudStorageManager.html#create" class="tsd-kind-icon">create</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="GoCloudStorageManager.html#getStorageIconPath" class="tsd-kind-icon">get<wbr>Storage<wbr>Icon<wbr>Path</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="GoCloudStorageManager.html#handleAction" class="tsd-kind-icon">handle<wbr>Action</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="GoCloudStorageManager.html#hideMenu" class="tsd-kind-icon">hide<wbr>Menu</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="GoCloudStorageManager.html#load" class="tsd-kind-icon">load</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="GoCloudStorageManager.html#remove" class="tsd-kind-icon">remove</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="GoCloudStorageManager.html#save" class="tsd-kind-icon">save</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="GoCloudStorageManager.html#selectStorageService" class="tsd-kind-icon">select<wbr>Storage<wbr>Service</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="GoCloudStorageManager.html#showMessage" class="tsd-kind-icon">show<wbr>Message</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <div class="container-fluid bottom-copyright plr15"> Copyright &copy; 1998-2020 by Northwoods Software Corporation. </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script src="../../assets/js/api.js"></script> <script src="../../assets/js/bootstrap.min.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-1506307-5', 'auto'); ga('send', 'pageview'); </script> </body> </html>