markgojs

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>GoLocalStorage | GoCloudStorage 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>  <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> </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">GoCloudStorage 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> <input type="checkbox" id="tsd-filter-inherited" /> <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-fluid plr15"> <div class="top-copyright">  GoCloudStorage<br/>by <a href="https://www.nwoods.com/">Northwoods Software®</a> </div> <div> <h1>Class GoLocalStorage</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-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <a href="GoCloudStorage.html" class="tsd-signature-type">GoCloudStorage</a> <ul class="tsd-hierarchy"> <li> <span class="target">GoLocalStorage</span> </li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <p>Class for saving / loading <a href="https://gojs.net/latest/api/symbols/Diagram.html">Diagram</a> <a href="https://gojs.net/latest/api/symbols/Model.html">models</a> to / from Local Storage. GoLocalStorage is the only <a href="GoCloudStorage.html">GoCloudStorage</a> subclass than can be used in a local page; that is, one not served by a web server.</p> <p><b>Note</b>: that this class will not work with browsers that do not have Local Storage support (like some old versions of Internet Explorer).</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 tsd-is-overwrite"><a href="GoLocalStorage.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-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="GoLocalStorage.html#className" class="tsd-kind-icon">class<wbr>Name</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="GoLocalStorage.html#clientId" class="tsd-kind-icon">client<wbr>Id</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="GoLocalStorage.html#currentDiagramFile" class="tsd-kind-icon">current<wbr>Diagram<wbr>File</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="GoLocalStorage.html#defaultModel" class="tsd-kind-icon">default<wbr>Model</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="GoLocalStorage.html#iconsRelativeDirectory" class="tsd-kind-icon">icons<wbr>Relative<wbr>Directory</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="GoLocalStorage.html#isAutoSaving" class="tsd-kind-icon">is<wbr>Auto<wbr>Saving</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="GoLocalStorage.html#localStorage" class="tsd-kind-icon">local<wbr>Storage</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="GoLocalStorage.html#managedDiagrams" class="tsd-kind-icon">managed<wbr>Diagrams</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="GoLocalStorage.html#serviceName" class="tsd-kind-icon">service<wbr>Name</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="GoLocalStorage.html#ui" class="tsd-kind-icon">ui</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 tsd-is-overwrite"><a href="GoLocalStorage.html#authorize" class="tsd-kind-icon">authorize</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoLocalStorage.html#checkFileExists" class="tsd-kind-icon">check<wbr>File<wbr>Exists</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="GoLocalStorage.html#create" class="tsd-kind-icon">create</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoLocalStorage.html#getFile" class="tsd-kind-icon">get<wbr>File</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="GoLocalStorage.html#getUserInfo" class="tsd-kind-icon">get<wbr>User<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="GoLocalStorage.html#hideUI" class="tsd-kind-icon">hideUI</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoLocalStorage.html#load" class="tsd-kind-icon">load</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoLocalStorage.html#loadWithUI" class="tsd-kind-icon">load<wbr>WithUI</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoLocalStorage.html#remove" class="tsd-kind-icon">remove</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoLocalStorage.html#removeWithUI" class="tsd-kind-icon">remove<wbr>WithUI</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoLocalStorage.html#save" class="tsd-kind-icon">save</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoLocalStorage.html#saveWithUI" class="tsd-kind-icon">save<wbr>WithUI</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoLocalStorage.html#showUI" class="tsd-kind-icon">showUI</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 tsd-is-overwrite"> <a name="constructor" class="tsd-anchor"></a> <h3> constructor </h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">new <wbr>GoLocal<wbr>Storage<span class="tsd-signature-symbol">(</span>managedDiagrams<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Diagram</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Diagram</span><span class="tsd-signature-symbol">[]</span>, defaultModel<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</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="GoLocalStorage.html" class="tsd-signature-type">GoLocalStorage</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>managedDiagrams: <span class="tsd-signature-type">Diagram</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Diagram</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>An array of GoJS <a href="https://gojs.net/latest/api/symbols/Diagram.html">Diagrams</a> whose model(s) will be saved to / loaded from Local Storage. Can also be a single Diagram.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> defaultModel: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>String representation of the default model data for new diagrams. If this is null, default new diagrams will be empty. Usually a value given by calling <a href="https://gojs.net/latest/api/symbols/Model.html#toJson">.toJson()</a> on a GoJS Diagram's Model.</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 GoLocalStorage exists, in which the storage service brand icons can be found. The default value is "../goCloudStorageIcons/".</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="GoLocalStorage.html" class="tsd-signature-type">GoLocalStorage</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-get-signature tsd-parent-kind-class tsd-is-inherited"> <a name="className" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagReadOnly">Read-only</span> class<wbr>Name <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 the name of the class; i.e. "GoDropbox"</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a name="clientId" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagReadOnly">Read-only</span> client<wbr>Id <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 the clientId for the app using the cloud storage service. This is usually given by the cloud storage provider's dev console or similar. Set with a parameter during construction.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <a name="currentDiagramFile" class="tsd-anchor"></a> <h3> current<wbr>Diagram<wbr>File <span class="tsd-signature-symbol">: </span><a href="DiagramFile.html" class="tsd-signature-type">DiagramFile</a> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get or set the currently open <a href="DiagramFile.html">DiagramFile</a>. By default, currentDiagramFile is set when a file is loaded from storage, saved to storage (if saved to a different path from the currentDiagramFile.path), or deleted from storage (if the deleted file is the currently open one). The default value is a <a href="DiagramFile.html">DiagramFile</a> with null id, name, and path values.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <a name="defaultModel" class="tsd-anchor"></a> <h3> default<wbr>Model <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 the defaultModel data for the app used by an instance of GoCloudStorage. defaultModel is used when creating new diagrams. See <a href="GoLocalStorage.html#create">create</a>.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <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 GoCloudStorage exists, in which the storage service brand icons can be found. The default value is "../goCloudStorageIcons/".</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <a name="isAutoSaving" class="tsd-anchor"></a> <h3> is<wbr>Auto<wbr>Saving <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get or set isAutoSaving property. If true, the <a href="GoLocalStorage.html#managedDiagrams">managedDiagrams</a> will be saved to storage after every <a href="https://gojs.net/latest/api/symbols/Transaction.html"> Transaction</a> (only if <a href="GoLocalStorage.html#currentDiagramFile">currentDiagramFile</a> holds a non-null path value). Additionally, if isAutoSaving is true, users will be prompted to save newly created diagrams when created with <a href="GoLocalStorage.html#create">create</a>. The default value for isAutoSaving is <code>true</code>.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="localStorage" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagReadOnly">Read-only</span> local<wbr>Storage <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Storage</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get the browser window's <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage">Local Storage</a> property.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <a name="managedDiagrams" class="tsd-anchor"></a> <h3> managed<wbr>Diagrams <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Diagram</span><span class="tsd-signature-symbol">[]</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get / set the GoJS <a href="https://gojs.net/latest/api/symbols/Diagram.html">Diagram</a>s associated with this instance of GoCloudStorage. Set with a parameter during construction.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a name="serviceName" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagReadOnly">Read-only</span> service<wbr>Name <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 the name of the cloud storage service being used; i.e. "Dropbox"</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a name="ui" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagReadOnly">Read-only</span> ui <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 the UI element associated with this instance of GoCloudStorage. This is a custom filepicker window for <a href="GoDropBox.html">GoDropBox</a> and <a href="GoLocalStorage.html">GoLocalStorage</a>. It is a save prompt for <a href="GoOneDrive.html">GoOneDrive</a> and <a href="GoGoogleDrive.html">GoGoogleDrive</a> (both these classes use third party UI for storage navigation, provided by Microsoft and Google, respectively). The UI element is created 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 tsd-is-overwrite"> <a name="authorize" class="tsd-anchor"></a> <h3> authorize </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">authorize<span class="tsd-signature-symbol">(</span>refreshToken<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"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Check if Local Storage is supported by the current browser.</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> refreshToken: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5> <div class="tsd-comment tsd-typography"> <p>This parameter can be ignored. It exists only to maintain GoCloudStorage system structure</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a Promise that resolves with a boolean (true if local storage is supported, false if not)</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="checkFileExists" class="tsd-anchor"></a> <h3> check<wbr>File<wbr>Exists </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">check<wbr>File<wbr>Exists<span class="tsd-signature-symbol">(</span>path<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Check whether a file exists in LocalStorage at a given path.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A valid key corresponding to a saved diagram file in Local Storage</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a Promise that resolves with a boolean stating whether a file exists in LocalStorage at a given path</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="create" class="tsd-anchor"></a> <h3> create </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>path<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Set each of <a href="GoLocalStorage.html#managedDiagrams">managedDiagrams</a>' .model to <a href="GoLocalStorage.html#defaultModel">defaultModel</a> (if defaultModel is null, each model will be set to a new <a href="https://gojs.net/latest/api/symbols/GraphLinksModel.html">GraphLinksModel</a> by default). If <a href="GoLocalStorage.html#isAutoSaving">isAutoSaving</a> is true and no path parameter is supplied, users will be immediately prompted to save their new diagrams to cloud storage.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> path: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>If a valid filepath is supplied, save each of <a href="GoLocalStorage.html#managedDiagrams">managedDiagrams</a>' model data to this path. No UI of any sort appears. What is meant by "valid filepath" varies from subclass to subclass. Rules for valid filepaths by subclass:</p> <ul> <li><a href="GoLocalStorage.html">GoLocalStorage</a>: Just the filename (the key in local storage); i.e. <code>example.diagram</code></li> <li><a href="GoDropBox.html">GoDropBox</a>: <code>/{path-to-file}/{filename}</code>; i.e. <code>/Public/example.diagram</code></li> <li><a href="GoGoogleDrive.html">GoGoogleDrive</a>: Use Google Drive-given file IDs. Parameter is still called 'path' in GoGoogleDrive methods to preserve system nomenclature.</li> <li><a href="GoOneDrive.html">GoOneDrive</a>: <code>/drive/root:/{path-to-file}/{filename}</code>; i.e. <code>/drive/root:/Documents/example.diagram</code></li> </ul> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a Promise that resolves with a <a href="DiagramFile.html">DiagramFile</a> representing the newly created file.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="getFile" class="tsd-anchor"></a> <h3> get<wbr>File </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">get<wbr>File<span class="tsd-signature-symbol">(</span>path<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get information about a diagram file saved to local storage. This data includes:</p> <ul> <li>content: The content of the saved file (a string respresentation of a GoJS Diagram Model)</li> <li>id: The key of the file in local storage</li> <li>name: Same as id value</li> <li>path: Same as id value</li> <ul> <p><b>Note:</b> Id, name, and path are all provided (despite being the same). They are requisite for creating valid <a href="DiagramFile.html">DiagramFile</a>s. </p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A valid key corresponding to a saved diagram file in Local Storage</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a Promise that resolves with information about a diagram file saved to local storage</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="getUserInfo" class="tsd-anchor"></a> <h3> get<wbr>User<wbr>Info </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">get<wbr>User<wbr>Info<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"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get information about the currently logged in user. This information varies from subclass to subclass. For more info, see:</p> <ul> <li><a href="GoLocalStorage.html#getUserInfo">GoLocalStorage.getUserInfo</a></li> <li><a href="GoDropBox.html#getUserInfo">GoDropBox.getUserInfo</a></li> <li><a href="GoGoogleDrive.html#getUserInfo">GoGoogleDrive.getUserInfo</a></li> <li><a href="GoOneDrive.html#getUserInfo">GoOneDrive.getUserInfo</a></li> </ul> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a Promise that resolves with information about the currently logged in user</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="hideUI" class="tsd-anchor"></a> <h3> hideUI </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">hideUI<span class="tsd-signature-symbol">(</span>isActionCanceled<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Hide the <a href="GoLocalStorage.html#ui">ui</a> element associated with this instance of GoCloudStorage. Used in some UI element onclicks.</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> isActionCanceled: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5> <div class="tsd-comment tsd-typography"> <p>If action (save, delete, load) is canceled, resolve Promise (returned previously in <a href="GoLocalStorage.html#showUI">showUI</a>) with a 'Canceled' notification. Default value is false.</p> </div> </li> </ul> <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 tsd-is-overwrite"> <a name="load" class="tsd-anchor"></a> <h3> load </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>path<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get the contents of a given file; load to <a href="GoLocalStorage.html#managedDiagrams">managedDiagrams</a> model.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A valid localstorage key to load diagram model data from</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></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 tsd-is-overwrite"> <a name="loadWithUI" class="tsd-anchor"></a> <h3> load<wbr>WithUI </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">load<wbr>WithUI<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"><</span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get the contents of a given file; load to <a href="GoLocalStorage.html#managedDiagrams">managedDiagrams</a> model. Use the custom filepicker <a href="GoLocalStorage.html#ui">ui</a>.</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></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 tsd-is-overwrite"> <a name="remove" class="tsd-anchor"></a> <h3> remove </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">remove<span class="tsd-signature-symbol">(</span>path<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Delete a given diagram from Local Storage.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A valid localstorage key to delete diagram model data from</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></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 tsd-is-overwrite"> <a name="removeWithUI" class="tsd-anchor"></a> <h3> remove<wbr>WithUI </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">remove<wbr>WithUI<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"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Delete a diagram from Local Storage using the custom filepicker menu <a href="GoLocalStorage.html#ui">ui</a>.</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></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 tsd-is-overwrite"> <a name="save" class="tsd-anchor"></a> <h3> save </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">save<span class="tsd-signature-symbol">(</span>path<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Save <a href="GoLocalStorage.html#managedDiagrams">managedDiagrams</a>' model data to Local Storage. If path is supplied save to that path. If no path is supplied but <a href="GoLocalStorage.html#currentDiagramFile">currentDiagramFile</a> has non-null, valid properties, update saved diagram file content at the key in Local Storage corresponding to currentDiagramFile.path with current managedDiagrams' model data. If no path is supplied and currentDiagramFile is null or has null properties, this calls <a href="GoLocalStorage.html#saveWithUI">saveWithUI</a>.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> path: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A string to save diagram model data to (becomes the key for the file in Local Storage)</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></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 tsd-is-overwrite"> <a name="saveWithUI" class="tsd-anchor"></a> <h3> save<wbr>WithUI </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">save<wbr>WithUI<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"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Save the current <a href="GoLocalStorage.html#managedDiagrams">managedDiagrams</a>'s model data to Local Storage using the custom filepicker <a href="GoLocalStorage.html#ui">ui</a>.</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></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 tsd-is-overwrite"> <a name="showUI" class="tsd-anchor"></a> <h3> showUI </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">showUI<span class="tsd-signature-symbol">(</span>action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, numAdditionalFiles<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">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Show the custom Go Local Storage filepicker <a href="GoLocalStorage.html#ui">ui</a>.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>action: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Clarify what action is being done after file selection. Must be one of the following:</p> <ul> <li>New</li> <li>Open</li> <li>Save</li> <li>Delete</li> </ul> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> numAdditionalFiles: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>Optional: Number of files to show in UI, in addition to a static numerical property (that can only be modified by changing source code). This prevents long wait times while the UI loads if there are a large number of diagram files stored in Local Storage.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> <p>Returns a Promise that resolves (in <a href="GoLocalStorage.html#save">save</a>, <a href="GoLocalStorage.html#load">load</a>, or <a href="GoLocalStorage.html#remove">remove</a> with an <a href="DiagramFile.html">DiagramFile</a> representing the saved/loaded/deleted file</p> </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>Go <wbr>Cloud <wbr>Storage <wbr>Class <wbr>Index</em></a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class"> <a href="GoCloudStorage.html" class="tsd-kind-icon">Go<wbr>Cloud<wbr>Storage</a> </li> <li class=" tsd-kind-class"> <a href="GoCloudStorageManager.html" class="tsd-kind-icon">Go<wbr>Cloud<wbr>Storage<wbr>Manager</a> </li> <li class=" tsd-kind-class"> <a href="GoDropBox.html" class="tsd-kind-icon">Go<wbr>Drop<wbr>Box</a> </li> <li class=" tsd-kind-class"> <a href="GoGoogleDrive.html" class="tsd-kind-icon">Go<wbr>Google<wbr>Drive</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-class"> <a href="GoLocalStorage.html" class="tsd-kind-icon">Go<wbr>Local<wbr>Storage</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <a href="GoLocalStorage.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a href="GoLocalStorage.html#className" class="tsd-kind-icon">class<wbr>Name</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a href="GoLocalStorage.html#clientId" class="tsd-kind-icon">client<wbr>Id</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <a href="GoLocalStorage.html#currentDiagramFile" class="tsd-kind-icon">current<wbr>Diagram<wbr>File</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <a href="GoLocalStorage.html#defaultModel" class="tsd-kind-icon">default<wbr>Model</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <a href="GoLocalStorage.html#iconsRelativeDirectory" class="tsd-kind-icon">icons<wbr>Relative<wbr>Directory</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <a href="GoLocalStorage.html#isAutoSaving" class="tsd-kind-icon">is<wbr>Auto<wbr>Saving</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="GoLocalStorage.html#localStorage" class="tsd-kind-icon">local<wbr>Storage</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <a href="GoLocalStorage.html#managedDiagrams" class="tsd-kind-icon">managed<wbr>Diagrams</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a href="GoLocalStorage.html#serviceName" class="tsd-kind-icon">service<wbr>Name</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a href="GoLocalStorage.html#ui" class="tsd-kind-icon">ui</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a href="GoLocalStorage.html#authorize" class="tsd-kind-icon">authorize</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a href="GoLocalStorage.html#checkFileExists" class="tsd-kind-icon">check<wbr>File<wbr>Exists</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="GoLocalStorage.html#create" class="tsd-kind-icon">create</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a href="GoLocalStorage.html#getFile" class="tsd-kind-icon">get<wbr>File</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="GoLocalStorage.html#getUserInfo" class="tsd-kind-icon">get<wbr>User<wbr>Info</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="GoLocalStorage.html#hideUI" class="tsd-kind-icon">hideUI</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a href="GoLocalStorage.html#load" class="tsd-kind-icon">load</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a href="GoLocalStorage.html#loadWithUI" class="tsd-kind-icon">load<wbr>WithUI</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a href="GoLocalStorage.html#remove" class="tsd-kind-icon">remove</a> </li> <li class=" tsd-kind-method ts