forked from NorthwoodsSoftware/GoJS
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathstorage.html
More file actions
593 lines (554 loc) · 31.4 KB
/
Copy pathstorage.html
File metadata and controls
593 lines (554 loc) · 31.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, viewport-fit=cover"/>
<link rel="stylesheet" href="../assets/css/style.css"/>
<!-- Copyright 1998-2022 by Northwoods Software Corporation. --> <title> GoJS Storage -- Northwoods Software </title>
<link rel="stylesheet" href="../assets/css/prism.css" />
</head>
<script>
window.diagrams = [];
window.goCode = function(pre, w, h, parentid, animation) {
window.diagrams.push([pre, w, h, parentid, animation]);
}
</script>
<body>
<nav id="navTop" class="w-full z-30 top-0 text-white bg-nwoods-primary">
<div class="w-full container max-w-screen-lg mx-auto flex flex-wrap sm:flex-nowrap items-center justify-between mt-0 py-2">
<div class="md:pl-4">
<a class="text-white hover:text-white no-underline hover:no-underline
font-bold text-2xl lg:text-4xl rounded-lg hover:bg-nwoods-secondary " href="../">
<h1 class="mb-0 p-1 ">GoJS</h1>
</a>
</div>
<button id="topnavButton" class="rounded-lg sm:hidden focus:outline-none focus:ring" aria-label="Navigation">
<svg fill="currentColor" viewBox="0 0 20 20" class="w-6 h-6">
<path id="topnavOpen" fill-rule="evenodd" d="M3 5a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM3 10a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM9 15a1 1 0 011-1h6a1 1 0 110 2h-6a1 1 0 01-1-1z" clip-rule="evenodd"></path>
<path id="topnavClosed" class="hidden" fill-rule="evenodd" d="M4.293 4.293a1 1 0 011.414 0L10 8.586l4.293-4.293a1 1 0 111.414 1.414L11.414 10l4.293 4.293a1 1 0 01-1.414 1.414L10 11.414l-4.293 4.293a1 1 0 01-1.414-1.414L8.586 10 4.293 5.707a1 1 0 010-1.414z" clip-rule="evenodd"></path>
</svg>
</button>
<div id="topnavList" class="hidden sm:block items-center w-auto mt-0 text-white p-0 z-20">
<ul class="list-reset list-none font-semibold flex justify-end flex-wrap sm:flex-nowrap items-center px-0 pb-0">
<li class="p-1 sm:p-0"><a class="topnav-link" href="../learn/">Learn</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../samples/">Samples</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../intro/">Intro</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../api/">API</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/products/register.html">Register</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../download.html">Download</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="https://forum.nwoods.com/c/gojs/11">Forum</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/contact.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/contact.html', 'contact');">Contact</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/sales/index.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/sales/index.html', 'buy');">Buy</a></li>
</ul>
</div>
</div>
<hr class="border-b border-gray-600 opacity-50 my-0 py-0" />
</nav>
<div class="md:flex flex-col md:flex-row md:min-h-screen w-full max-w-screen-xl mx-auto">
<div id="navSide" class="flex flex-col w-full md:w-40 lg:w-48 text-gray-700 bg-white flex-shrink-0">
<div class="flex-shrink-0 px-8 py-4">
<button id="navButton" class="rounded-lg md:hidden focus:outline-none focus:ring" aria-label="Navigation">
<svg fill="currentColor" viewBox="0 0 20 20" class="w-6 h-6">
<path id="navOpen" fill-rule="evenodd" d="M3 5a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM3 10a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM9 15a1 1 0 011-1h6a1 1 0 110 2h-6a1 1 0 01-1-1z" clip-rule="evenodd"></path>
<path id="navClosed" class="hidden" fill-rule="evenodd" d="M4.293 4.293a1 1 0 011.414 0L10 8.586l4.293-4.293a1 1 0 111.414 1.414L11.414 10l4.293 4.293a1 1 0 01-1.414 1.414L10 11.414l-4.293 4.293a1 1 0 01-1.414-1.414L8.586 10 4.293 5.707a1 1 0 010-1.414z" clip-rule="evenodd"></path>
</svg>
</button>
</div>
<nav id="navList" class="min-h-screen hidden md:block sidebar-nav flex-grow px-1 lg:px-4 pb-4 md:pb-0 md:overflow-y-auto break-words">
<a href="index.html">Basics</a>
<a href="buildingObjects.html">Building Parts</a>
<a href="usingModels.html">Using Models</a>
<a href="dataBinding.html">Data Binding</a>
<a href="react.html">GoJS with React</a>
<a href="angular.html">GoJS with Angular</a>
<a href="textBlocks.html">TextBlocks</a>
<a href="shapes.html">Shapes</a>
<a href="pictures.html">Pictures</a>
<a href="panels.html">Panels</a>
<a href="tablePanels.html">Table Panels</a>
<a href="brush.html">Brushes</a>
<a href="sizing.html">Sizing Objects</a>
<a href="itemArrays.html">Item Arrays</a>
<a href="changedEvents.html">Changed Events</a>
<a href="transactions.html">Transactions</a>
<a href="viewport.html">Coordinates</a>
<a href="initialView.html">Initial View</a>
<a href="collections.html">Collections</a>
<a href="links.html">Links</a>
<a href="linkLabels.html">Link Labels</a>
<a href="connectionPoints.html">Link Points</a>
<a href="ports.html">Ports</a>
<a href="nodes.html">Nodes</a>
<a href="debugging.html">Debugging</a>
<a href="layouts.html">Layouts</a>
<a href="trees.html">Trees</a>
<a href="subtrees.html">SubTrees</a>
<a href="groups.html">Groups</a>
<a href="subgraphs.html">SubGraphs</a>
<a href="sizedGroups.html">Sized Groups</a>
<a href="selection.html">Selection</a>
<a href="highlighting.html">Highlighting</a>
<a href="animation.html">Animation</a>
<a href="toolTips.html">ToolTips</a>
<a href="contextmenus.html">Context Menus</a>
<a href="events.html">Diagram Events</a>
<a href="tools.html">Tools</a>
<a href="commands.html">Commands</a>
<a href="permissions.html">Permissions</a>
<a href="validation.html">Validation</a>
<a href="HTMLInteraction.html">HTML Interaction</a>
<a href="layers.html">Layers & Z-ordering</a>
<a href="palette.html">Palette</a>
<a href="overview.html">Overview</a>
<a href="resizing.html">Resizing Diagrams</a>
<a href="replacingDeleting.html">Replacing and Deleting</a>
<a href="buttons.html">Buttons</a>
<a href="templateMaps.html">Template Maps</a>
<a href="legends.html">Legends and Titles</a>
<a href="extensions.html">Extensions</a>
<a href="geometry.html">Geometry Strings</a>
<a href="grids.html">Grid Patterns</a>
<a href="graduatedPanels.html">Graduated Panels</a>
<a href="makingImages.html">Diagram Images</a>
<a href="makingSVG.html">Diagram SVG</a>
<a href="printing.html">Printing</a>
<a href="serverSideImages.html">Server-side Images</a>
<a href="nodeScript.html">GoJS in Node.js</a>
<a href="testing.html">Testing</a>
<a href="storage.html">Storage</a>
<a href="performance.html">Performance</a>
<a href="source.html">Building from Source</a>
<a href="platforms.html">Platforms</a>
<a href="deployment.html">Deployment</a>
<a href="typings.html">Typings</a>
</nav>
</div>
<div class="pt-4 px-2 md:px-0 lg:px-4 pb-16 w-full overflow-hidden">
<h1>Storage</h1>
<p>
Storing GoJS model data in cloud storage is an excellent way to save, load, create, and delete diagram data files without worrying about local system concerns.
Interfacing with popular cloud storage services is made easy with the GoCloudStorage library.
</p>
<p>
The GoCloudStorage library is not pre-packaged with GoJS. You can find the GoCloudStorage library <a href="../projects/storage/lib/gcs.js">here</a>.
</p>
<p>
The GoCloudStorage class system lets developers easily store their GoJS diagram model data to popular cloud storage services. The
<a href="../api/symbols/GoCloudStorage.html">GoCloudStorage class</a> itself is an abstract class, never to be instantiated.
Instead, its subclasses are used, each interfacing with a different cloud storage service. Currently, the GoCloudStorage system supports Dropbox,
Google Drive, Microsoft OneDrive, and Local Storage. Class names are:
<ul>
<li><a href="../api/symbols/GoDropBox.html">GoDropBox</a></li>
<li><a href="../api/symbols/GoGoogleDrive.html">GoGoogleDrive</a></li>
<li><a href="../api/symbols/GoOneDrive.html">GoOneDrive</a></li>
<li><a href="../api/symbols/GoLocalStorage.html">GoLocalStorage</a></li>
</ul>
</p>
<h3 id="GoCloudStorageSubclassConstruction">GoCloudStorage Subclass Construction</h3>
<p>
This section provides a description of how to create an instance of a specific GoCloudStorage subclass, GoGoogleDrive. Due to the variable nature of
cloud storage service APIs, GoCloudStorage subclass constructor parameters and behavior vary. It is recommended you read the full
<a href="../api/index.html">documentation</a> for any GoCloudStorage subclass you wish to use.
</p>
<p>
First, ensure you have a <code>script</code> tag with the path to your <code>gcs.js</code> library. All GoCloudStorage
subclasses are defined in the namespace <code>gcs</code>.
</p>
<p>
<strong>Note</strong>: To use any GoCloudStorage subclass (except for <a href="../api/symbols/GoLocalStorage.html">GoLocalStorage</a>), you must
also include a <code>script</code> tag referencing the storage service provider JS library. For each subclass, these could be something like:
<ul>
<li><a href="../api/symbols/GoDropBox.html">GoDropBox</a>: https://unpkg.com/dropbox@2.5.13/dist/DropboxTeam-sdk.min.js </li>
<li><a href="../api/symbols/GoGoogleDrive.html">GoGoogleDrive</a>: https://apis.google.com/js/api.js</li>
<li><a href="../api/symbols/GoOneDrive.html">GoOneDrive</a>: https://js.live.net/v7.2/OneDrive.js </li>
</ul>
</p>
<p>
Here is a valid constructor call for GoGoogleDrive.
</p>
<pre class="lang-js" id="simple"><code>
// Create a valid GoGoogleDrive instance
var ggd = new gcs.GoGoogleDrive(
diagrams, // managedDiagrams parameter
"16225356139-n64vtg7konuetna3of3mfcaj2iffhgmg.apps.googleusercontent.com", // clientId parameter
"AIzaSydBje3lBL67MMVKw467_pvuRg7_XMVGf18", // pickerApiKey parameter
defaultModel, // defaultModel parameter
"../projects/storage/goCloudStorageIcons/" // iconsRelativeDirectory parameter
);
</code></pre>
<p>
<strong>Note</strong>: All client ID's / API keys on this page are fabricated, and for example purposes only.
</p>
<p>
What are all these parameters? We'll step through them, one by one.
</p>
<h4 id="ManagedDiagrams">Managed Diagrams </h4>
<p>
The first parameter passed to the GoGoogleDrive constructor is something called <code>diagrams</code>. This is the parameter known to all GoCloudStorage subclasses
as <code><a href="../api/symbols/GoCloudStorage.html#managedDiagrams">managedDiagrams</a></code>. It is either an Array of
GoJS Diagrams or a single GoJS Diagram that this instance of GoCloudStorage (in this case, GoGoogleDrive) will manage data storage for.
This parameter is required.
</p>
<h4 id="ClientID">Client ID</h4>
<p>
The second parameter passed to the GoGoogleDrive constructor is a long string. This is the <code>
<a href="../api/symbols/GoCloudStorage.html#clientId">clientId</a></code> parameter, required by all GoCloudStorage subclasses (except
<a href="../api/symbols/GoLocalStorage.html">GoLocalStorage</a>). This ID tells the cloud storage provider (in this case, Google) and the user
what application is asking to manipulate stored file data (in this case, Google Drive file data).
</p>
<p>
This is usually given by the cloud storage provider's developer console or similar.
You will need to register an application with the storage provider (in this case, Google) to obtain this ID.
Read more below at <a href="#ObtainingClientIDs">Obtaining Client IDs</a>.
</p>
<h4 id="GooglePickerAPIKey">Google Picker API Key</h4>
<p>
This is a GoGoogleDrive-specific parameter. Some GoCloudStorage subclasses require parameters that others do not.
Again, it is recommended you read the full <a href="../api/index.html">documentation</a> for any GoCloudStorage subclass you wish to use.
</p>
<p>
GoGoogleDrive requires this key to allow for the familiar, Google Drive file picker interface during graphical file manipulation. Read more about this special parameter
in the full <code><a href="../api/symbols/GoGoogleDrive.html#pickerApiKey">GoGoogleDrive.pickerApiKey</a></code> documentation.
</p>
<h4 id="DefaultModel">Default Model </h4>
<p>
It is the default model data assigned to newly created diagrams with calls to
<code><a href="../api/symbols/GoCloudStorage.html#create">create</a></code>. Generally, this value is obtained with a call to
<a href="../api/symbols/Model.html#toJson">Diagram.model.toJson()</a>.
</p>
<p>
This is an optional parameter for all GoCloudStorage subclasses.
If no value is supplied during construction, this defaults to a new <a href="../api/symbols/GraphLinksModel.html">GraphLinksModel</a>.
</p>
<h4 id="IconsRelativeDirectory">Icons Relative Directory</h4>
<p>
To use commands that call a GoCloudStorage subclass' custom <code><a href="../api/symbols/GoCloudStorage.html#ui">ui</a></code>,
you must specify the directory in which the icons for storage services reside, relative to the directory your application page is. This is provided
by the optional <code><a href="../api/symbols/GoCloudStorage.html#iconsRelativeDirectory">iconsRelativeDirectory</a></code> parameter. The default value is
"../goCloudStorageIcons/".
</p>
<p>
Exactly what the UI looks like varies between GoCloudStorage subclasses, though it certainly contains references to storage service icons. Without providing this
parameter, it's likely the space where these images go will appear blank.
</p>
<p>
Please refer to the full <a href="../api/index.html">documentation</a> for details on class-specific UIs.
</p>
<h3 id="ObtainingClientIDs">Obtaining Client IDs</h3>
<p>
All GoCloudStorage subclasses (except <a href="../api/symbols/GoLocalStorage.html">GoLocalStorage</a>) require a client ID as a parameter during construction.
This lets the storage service provider (i.e. Google, Dropbox...) and the user know the identity of the application trying to manipulate their remote filesystems.
Therefore, obtaining a client ID for the storage service you wish to use is a requirement to using the corresponding GoCloudStorage subclass.
</p>
<p>
The process for this varies from service to service, though the general steps are the same.
</p>
<ol>
<li><strong>Register an account</strong></li>
<p>
If you do not already have an account with the storage service provider, make one.
</p>
<li><strong>Register a web application</strong></li>
<p>
This step varies most from service to service. Create and register an application with the storage service provider.
</p>
<li><strong>Locate your new application's Client ID</strong></li>
<p>
Your newly registered application has a Client ID -- a long string like the one we saw in <a href="#GoCloudStorageSubclassConstruction">GoCloudStorage
Subclass Construction</a>. Use this string as the <code><a href="../api/symbols/GoCloudStorage.html#clientId">clientId</a></code> parameter for your
instance of GoCloudStorage.
</p>
</ol>
<p>
These storage-specific pages can help walk you through the process of creating / registering an application with their service.
<ul>
<li><a href="https://developers.google.com/drive/v3/web/quickstart/js">GoGoogleDrive</a></li>
<li><a href="https://docs.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/app-registration">Microsoft OneDrive (Graph)</a></li>
<li><a href="https://www.dropbox.com/developers">Dropbox</a></li>
</ul>
</p>
<h3 id="SavingLoadingData">Saving / Loading Data </h3>
<p>
Now that you have a working instance of a GoCloudStorage subclass, let's start saving and loading GoJS Diagram model data. We will continue with our
GoGoogleDrive example from <a href="#GoCloudStorageSubclassConstruction">GoCloudStorage Subclass Construction</a>, referring to our specific GoGoogleDrive instance as
<code>ggd</code>.
</p>
<p>
We can save the model data of <code>ggd.managedDiagrams</code> to Google Drive in a variety of ways.
</p>
<h4 id="SaveVsSaveWithUI">Save vs. Save With UI</h4>
<p>
All GoCloudStorage subclasses have the functions <code>save()</code> and <code>saveWithUI()</code>. What's the difference?
</p>
<p>
<code>saveWithUI()</code> shows the <a href="../api/symbols/GoCloudStorage.html#ui">ui</a> element of the invoking instance of
GoCloudStorage, letting the user graphically specify a file name and/or save location.
</p>
<p>
<code>save()</code> is more nuanced. There are three cases. Let's return to our GoGoogleDrive example and explore them.
</p>
<ol>
<li><strong>Saving With a Specified Path</strong></li>
<p>
A call to <code>ggd.save(<valid path string>)</code> will save to that specific path in Google Drive, without showing any UI.
</p>
<p>
<strong>Note</strong>: What constitutes a valid path string parameter varies from service to service. See
<a href="../api/symbols/GoCloudStorage.html#getFile"> documentation</a> for more details.
</p>
<li><strong>Saving With a Valid Current Diagram File</strong></li>
<p>
If no path is supplied, but <code>ggd</code> has a valid <code><a href="../api/symbols/GoCloudStorage.html#currentDiagramFile">currentDiagramFile</a></code>
(a representation of the file from Google Drive <code>ggd</code> has currently open, and whose contents are loaded in <code>ggd.managedDiagrams</code>' models),
then the diagram file content at the path in Google Drive corresponding to <code>ggd.currentDiagramFile.path</code> is updated with the model contents of
<code>ggd.managedDiagrams</code>.
</p>
<li><strong>Saving With Neither</strong></li>
<p>
If no path is supplied and <code>ggd.currentDiagramFile</code> is not valid, <code>ggd.saveWithUI()</code> is called, prompting the user for a save name / location.
</p>
</ol>
<h4 id="Loading">Loading</h4>
<p>
Loading file data is more straightforward.
</p>
<p>
<code><a href="../api/symbols/GoCloudStorage.html#load">load(<valid path string>)</a></code> loads file contents from the cloud storage service and
into each of <code>managedDiagrams</code>' models. No UI appears.
<br />
<strong>Example</strong>: <code>ggd.load('ahjdhe^3n4dlKd4r')</code>
</p>
<p>
<code><a href="../api/symbols/GoCloudStorage.html#loadWithUI">loadWithUI()</a></code> displays the
<a href="../api/symbols/GoCloudStorage.html#ui">ui</a> and lets the user graphically choose which file to load.
<br />
<strong>Example</strong>: <code>ggd.loadWithUI()</code>
</p>
<p>
<strong>Note 1</strong>: The file being loaded must have been saved to storage from a page with GoJS Diagrams whose DIV IDs correspond with the DIV IDs of
<code><a href="../api/symbols/GoCloudStorage.html#managedDiagrams">managedDiagrams</a></code>. Otherwise, it will not be clear to the GoCloudStorage subclass
where to load model data to.
<br />
<strong>Note 2</strong>: Model data loaded into <code>managedDiagrams</code> from storage must be processed appropriately within the
application containing the invoking instance of GoCloudStorage (via <a href="templateMaps.html">node / link templates</a> or some other method). The GoCloudStorage
class system does not store any information other than model data.
</p>
</p>
<h3 id="CreatingRemovingData">Creating / Removing Data </h3>
<h4 id="CreatingFiles">Creating Files</h4>
<p>
Continuing with our GoGoogleDrive example, how would you create a new file in storage to save <code>ggd.managedDiagrams</code> to? Call the <code>create</code> function.
</p>
<p>
<code>create()</code> sets each of <code>ggd.managedDiagrams</code> to <code>ggd.defaultModel</code> (assigned at construction, back in
<a href="#GoCloudStorageSubclassConstruction">GoCloudStorage Subclass Construction</a>). If
<code><a href="../api/symbols/GoCloudStorage.html#isAutoSaving">ggd.isAutoSaving</a></code> is true, you will be prompted to
save your newly refreshed <code>managedDiagrams</code> to Google Drive via an automatic call to <code>saveWithUI()</code>.
</p>
<p>
Optionally, the <code>create</code> function can accept a path parameter, just as the <code>save()</code> and <code>load()</code> functions described in
<a href="#savingLoadingData">Saving / Loading Data</a>. If supplied, once each of <code>ggd.managedDiagrams</code> is reset to <code>defaultModel</code>,
their model data is saved to the given path in Google Drive, and no UI appears.
</p>
<h4 id="RemovingFiles">Removing Files</h4>
<p>
To remove a file from Google Drive, simply call <code>ggd.remove(<some valid path string>)</code>. The file at the given path in Google Drive will be removed,
without showing any UI.
</p>
<p>
To remove a file from Google Drive with the <a href="../api/symbols/GoCloudStorage.html#ui">ui</a> element, call <code>ggd.removeWithUI()</code>.
</p>
<h3 id="GoCloudStorageManager">Go Cloud Storage Manager </h3>
<p>
What if you wanted to be able to save / load the diagrams on your page to / from many different cloud storage services? Say, Google Drive and Microsoft OneDrive?
Or Microsoft OneDrive, Dropbox, and Google Drive? Or any combination of the currently supported GoCloudStorage subclasses? That's what the
<a href="../api/symbols/GoCloudStorageManager.html">Go Cloud Storage Manager</a> is for.
</p>
<h4 id="ConstructingGoCloudStorageManager">Constructing the GoCloudStorageManager</h4>
<p>
Observe the standard GoCloudStorageManager construction process:
<pre class="lang-js"><code>
// Construct the CloudStorage subclasses you wish to manage
gls = new gcs.GoLocalStorage(myDiagram, defaultModel);
god = new gcs.GoOneDrive(myDiagram, 'f9b171a6-a12e-48c1-b86c-814ed40fcdd1', defaultModel);
ggd = new gcs.GoGoogleDrive(myDiagram, '16225373139-n24vtg7konuetna3ofbmfcaj2infhgmg.apps.googleusercontent.com',
'AIzaSyDBj43lBLpYMMVKw4aN_pvuRg7_XMVGf18', defaultModel);
gdb = new gcs.GoDropBox(myDiagram, '3sm2ko6q7u1gbix', defaultModel);
storages = [gls, god, ggd, gdb];
// Create the GoCloudStorageManager instance
storageManager = new gcs.GoCloudStorageManager(storages, "../projects/storage/goCloudStorageIcons/");
</code></pre>
Despite all that code, there are only two parameters GoCloudStorageManager takes.
</p>
<ul>
<li><strong><a href="../api/symbols/GoCloudStorageManager.html#storages">Storages</a></strong></li>
<p>
The first parameter, <code>storages</code>, is a either an Array or <a href="../api/Set.html">Set</a> of GoCloudStorage subclasses.
This tells the GoCloudStorageManager instance, <code>storageManager</code>, what storage services are being managed and how those services are managing their diagrams.
</p>
<li><strong><a href="../api/symbols/GoCloudStorageManager.html#iconsRelativeDirectory">Icons Relative Directory</a></strong></li>
<p>
The second parameter is a string, and corresponds to the
<code><a href="../api/symbols/GoCloudStorageManager.html#iconsRelativeDirectory">iconsRelativeDirectory</a></code> property of GoCloudStorageManager. This
is analogous to the <code>iconsRelativeDirectory</code> discussed in <a href="#GoCloudStorageSubclassConstruction">GoCloudStorage Subclass Construction</a>. The only
difference is the GoCloudStorageManager applies this property to each of the GoCloudStorage subclasses' <code>iconsRelativeDirectory</code> properties. This parameter
is optional, but not supplying it may mean there are blank spaces in the <a href="../api/symbols/GoCloudStorageManager.html#ui">ui</a> where the storage service
icons are supposed to be.
</p>
</ul>
<h4 id="UsingGoCloudStorageManager">Using the GoCloudStorageManager</h4>
<div style="text-align: center; padding: 20px;">
<figure >
<img src="images/gcsmSelectStorageService.png" />
<figcaption>The UI the appears after calling selectStorageService()</figcaption>
</figure>
</div>
<p>
First, set the GoCloudStorage subclass you want to use at the moment. This is done through a UI, which is brought up with a
call to <code><a href="../api/symbols/GoCloudStorageManager.html#selectStorageService">storageManager.selectStorageService()</a></code>.
<code><a href="../api/symbols/GoCloudStorageManager.html#currentStorageService">storageManager.currentStorageService</a></code> is set
to the GoCloudStorage subclass managing the storage service selected in the resultant UI.
</p>
<p>
The GoCloudStorageManager assumes a desire for mainly graphical manipulation of data, so calls to <code>save()</code>, <code>load()</code>, <code>create()</code>, and
<code>remove()</code> do not take any parameters and all launch the proper <a href="../api/symbols/GoCloudStorage.html#ui">ui</a> for
<code>storageManager.currentStorageService</code> (set by the the previous step).
</p>
<p>
You may want to update your page display or perform some other actions based on the saving / loading / removal / creation of data using GoCloudStorageManager.
All GoCloudStorageManager core methods (<code>save()</code>, <code>load()</code>, <code>create()</code>, and <code>remove()</code>) return Promises that resolve with
a <a href="../api/symbols/DiagramFile.html">DiagramFile</a>, representing the recently saved / loaded / created / removed file. With this data, you may update your
page display or perform any other action upon Promise resolution. Such as:
<pre class="lang-js"><code>
// resolving the Promise returned after the Load action
storageManager.load().then(function(fileData){
// the fileData is a DiagramFile object
alert(fileData.name + " (file ID " + fileData.id + ") loaded from path " + fileData.path);
});
</code></pre>
<strong>Note</strong>: There are three guaranteed fields in any DiagramFile object: the <a href="../api/symbols/DiagramFile.html#name">name</a>,
<a href="../api/symbols/DiagramFile.html#id">id</a>, and <a href="../api/symbols/DiagramFile.html#path">path</a> of the represented file.
</p>
</div>
</div>
<div class="bg-nwoods-primary">
<section class="max-w-screen-lg text-white container mx-auto py-2 px-12">
<p id="version" class="leading-none mb-2 my-4">GoJS</p>
</section>
</div><footer class="bg-nwoods-primary text-white">
<div class="container max-w-screen-lg mx-auto px-8">
<div class="w-full py-6">
<div class="max-w-screen-lg xl:max-w-screen-xl mx-auto px-4 sm:px-6 md:px-8">
<ul class="text-sm font-medium pb-6 grid grid-cols-2 sm:grid-cols-3 gap-y-10">
<li class="list-none row-span-2">
<h2 class="text-base font-semibold tracking-wide">GoJS</h2>
<ul class="list-none space-y-4 md:space-y-1 px-0">
<li>
<a href="../samples/index.html">Samples</a>
</li>
<li>
<a href="../learn/index.html">Learn</a>
</li>
<li>
<a href="../intro/index.html">Intro</a>
</li>
<li>
<a href="../api/index.html">API</a>
</li>
<li>
<a href="../changelog.html">Changelog</a>
</li>
<li>
<a href="https://github.com/NorthwoodsSoftware/GoJS">GitHub</a>
</li>
</ul>
</li>
<li class="list-none row-span-2">
<h2 class="text-base font-semibold tracking-wide">Support</h2>
<ul class="list-none space-y-4 md:space-y-1 px-0">
<li>
<a href="https://www.nwoods.com/contact.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/contact.html', 'contact');">Contact</a>
</li>
<li>
<a href="https://forum.nwoods.com/c/gojs">Forum</a>
</li>
<li>
<a href="https://www.nwoods.com/app/activate.aspx?sku=gojs">Activate</a>
</li>
<li>
<a href="https://www.nwoods.com/sales/index.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/sales/index.html', 'buy');">Buy</a>
</li>
<li>
<a href="https://www.youtube.com/channel/UC9We8EoX596-6XFjJDtZIDg">Videos</a>
</li>
</ul>
</li>
<li class="list-none row-span-2">
<h2 class="text-base font-semibold tracking-wide">Company</h2>
<ul class="list-none space-y-4 md:space-y-1 px-0">
<li>
<a target="_blank" href="https://www.nwoods.com">Northwoods</a>
</li>
<li>
<a target="_blank" href="https://www.nwoods.com/about.html">About Us</a>
</li>
<li>
<a target="_blank" href="https://www.nwoods.com/contact.html">Contact Us</a>
</li>
<li>
<a target="_blank" href="https://www.nwoods.com/consulting.html">Consulting</a>
</li>
<li>
<a target="_blank" href="https://twitter.com/northwoodsgo">Twitter</a>
</li>
</ul>
</li>
</ul>
<p class="text-sm text-gray-100 md:mb-6">
Copyright 1998-2022 <a class="text-white" href="https://www.nwoods.com">Northwoods Software</a>
</p>
</div>
</div>
</footer> </body>
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-1506307-5"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date()); gtag('config', 'UA-1506307-5');
var getOutboundLink = function(url, label) {
gtag('event', 'click', {
'event_category': 'outbound',
'event_label': label,
'transport_type': 'beacon'
});
}
// topnav
var topButton = document.getElementById("topnavButton");
var topnavList = document.getElementById("topnavList");
topButton.addEventListener("click", function() {
this.classList.toggle("active");
topnavList.classList.toggle("hidden");
document.getElementById("topnavOpen").classList.toggle("hidden");
document.getElementById("topnavClosed").classList.toggle("hidden");
});
</script>
<script src="../assets/js/prism.js"></script>
<script src="../release/go.js"></script>
<script src="../assets/js/goDoc.js"></script>
<script>
document.addEventListener("DOMContentLoaded", function() {
if (window.go) document.getElementById('version').textContent = "GoJS version " + go.version;
if (window.goDoc) window.goDoc();
var d = window.diagrams;
for (var i = 0; i < d.length; i++) {
var dargs = d[i];
goCodeExecute(dargs[0], dargs[1], dargs[2], dargs[3], dargs[4]);
}
if (window.extra) window.extra();
});
</script>
</html>