Skip to content

Commit 7706db9

Browse files
Publish mmstudio/latest
1 parent f127e3d commit 7706db9

12 files changed

Lines changed: 134 additions & 134 deletions

File tree

deprecated-list.html

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -407,15 +407,13 @@ <h2 title="Contents">Contents</h2>
407407
<td class="colOne"><a href="org/micromanager/PropertyMap.html#copy--">org.micromanager.PropertyMap.copy()</a></td>
408408
</tr>
409409
<tr class="altColor">
410-
<td class="colOne"><a href="org/micromanager/display/DisplaySettings.html#copy--">org.micromanager.display.DisplaySettings.copy()</a></td>
410+
<td class="colOne"><a href="org/micromanager/acquisition/SequenceSettings.html#copy--">org.micromanager.acquisition.SequenceSettings.copy()</a>
411+
<div class="block"><span class="deprecationComment">When used correctly, SequenceSettings are immutable.
412+
If you really need a copy, use copyBuilder().build();</span></div>
413+
</td>
411414
</tr>
412415
<tr class="rowColor">
413-
<td class="colOne"><a href="org/micromanager/data/Metadata.html#copy--">org.micromanager.data.Metadata.copy()</a>
414-
<div class="block"><span class="deprecationComment">Use the appropriate of the following:
415-
<a href="org/micromanager/data/Metadata.html#copyBuilderPreservingUUID--"><code>Metadata.copyBuilderPreservingUUID()</code></a>, <a href="org/micromanager/data/Metadata.html#copyBuilderWithNewUUID--"><code>Metadata.copyBuilderWithNewUUID()</code></a>,
416-
<a href="org/micromanager/data/Metadata.html#copyBuilderRemovingUUID--"><code>Metadata.copyBuilderRemovingUUID()</code></a>. This method is equivalent to
417-
<code>copyBuilderPreservingUUID</code>.</span></div>
418-
</td>
416+
<td class="colOne"><a href="org/micromanager/display/DisplaySettings.html#copy--">org.micromanager.display.DisplaySettings.copy()</a></td>
419417
</tr>
420418
<tr class="altColor">
421419
<td class="colOne"><a href="org/micromanager/data/SummaryMetadata.html#copy--">org.micromanager.data.SummaryMetadata.copy()</a>
@@ -428,9 +426,11 @@ <h2 title="Contents">Contents</h2>
428426
</td>
429427
</tr>
430428
<tr class="altColor">
431-
<td class="colOne"><a href="org/micromanager/acquisition/SequenceSettings.html#copy--">org.micromanager.acquisition.SequenceSettings.copy()</a>
432-
<div class="block"><span class="deprecationComment">When used correctly, SequenceSettings are immutable.
433-
If you really need a copy, use copyBuilder().build();</span></div>
429+
<td class="colOne"><a href="org/micromanager/data/Metadata.html#copy--">org.micromanager.data.Metadata.copy()</a>
430+
<div class="block"><span class="deprecationComment">Use the appropriate of the following:
431+
<a href="org/micromanager/data/Metadata.html#copyBuilderPreservingUUID--"><code>Metadata.copyBuilderPreservingUUID()</code></a>, <a href="org/micromanager/data/Metadata.html#copyBuilderWithNewUUID--"><code>Metadata.copyBuilderWithNewUUID()</code></a>,
432+
<a href="org/micromanager/data/Metadata.html#copyBuilderRemovingUUID--"><code>Metadata.copyBuilderRemovingUUID()</code></a>. This method is equivalent to
433+
<code>copyBuilderPreservingUUID</code>.</span></div>
434434
</td>
435435
</tr>
436436
<tr class="rowColor">
@@ -538,13 +538,13 @@ <h2 title="Contents">Contents</h2>
538538
</td>
539539
</tr>
540540
<tr class="rowColor">
541-
<td class="colOne"><a href="org/micromanager/display/DataViewer.html#getDatastore--">org.micromanager.display.DataViewer.getDatastore()</a>
542-
<div class="block"><span class="deprecationComment">use <a href="org/micromanager/display/DataViewer.html#getDataProvider--"><code>DataViewer.getDataProvider()</code></a> instead</span></div>
541+
<td class="colOne"><a href="org/micromanager/display/AbstractDataViewer.html#getDatastore--">org.micromanager.display.AbstractDataViewer.getDatastore()</a>
542+
<div class="block"><span class="deprecationComment">user code should call <code>getDataProvider</code></span></div>
543543
</td>
544544
</tr>
545545
<tr class="altColor">
546-
<td class="colOne"><a href="org/micromanager/display/AbstractDataViewer.html#getDatastore--">org.micromanager.display.AbstractDataViewer.getDatastore()</a>
547-
<div class="block"><span class="deprecationComment">user code should call <code>getDataProvider</code></span></div>
546+
<td class="colOne"><a href="org/micromanager/display/DataViewer.html#getDatastore--">org.micromanager.display.DataViewer.getDatastore()</a>
547+
<div class="block"><span class="deprecationComment">use <a href="org/micromanager/display/DataViewer.html#getDataProvider--"><code>DataViewer.getDataProvider()</code></a> instead</span></div>
548548
</td>
549549
</tr>
550550
<tr class="rowColor">
@@ -916,13 +916,13 @@ <h2 title="Contents">Contents</h2>
916916
</td>
917917
</tr>
918918
<tr class="altColor">
919-
<td class="colOne"><a href="org/micromanager/display/DataViewer.html#setDisplayedImageTo-org.micromanager.data.Coords-">org.micromanager.display.DataViewer.setDisplayedImageTo(Coords)</a>
920-
<div class="block"><span class="deprecationComment">use <a href="org/micromanager/display/DataViewer.html#setDisplayPosition-org.micromanager.data.Coords-"><code>DataViewer.setDisplayPosition(Coords)</code></a> instead</span></div>
919+
<td class="colOne"><a href="org/micromanager/display/AbstractDataViewer.html#setDisplayedImageTo-org.micromanager.data.Coords-">org.micromanager.display.AbstractDataViewer.setDisplayedImageTo(Coords)</a>
920+
<div class="block"><span class="deprecationComment">user code should call <code>setDisplayPosition</code></span></div>
921921
</td>
922922
</tr>
923923
<tr class="rowColor">
924-
<td class="colOne"><a href="org/micromanager/display/AbstractDataViewer.html#setDisplayedImageTo-org.micromanager.data.Coords-">org.micromanager.display.AbstractDataViewer.setDisplayedImageTo(Coords)</a>
925-
<div class="block"><span class="deprecationComment">user code should call <code>setDisplayPosition</code></span></div>
924+
<td class="colOne"><a href="org/micromanager/display/DataViewer.html#setDisplayedImageTo-org.micromanager.data.Coords-">org.micromanager.display.DataViewer.setDisplayedImageTo(Coords)</a>
925+
<div class="block"><span class="deprecationComment">use <a href="org/micromanager/display/DataViewer.html#setDisplayPosition-org.micromanager.data.Coords-"><code>DataViewer.setDisplayPosition(Coords)</code></a> instead</span></div>
926926
</td>
927927
</tr>
928928
<tr class="altColor">

org/micromanager/class-use/PropertyMap.html

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -200,14 +200,14 @@ <h3>Uses of <a href="../../../org/micromanager/PropertyMap.html" title="interfac
200200
</tr>
201201
<tr class="altColor">
202202
<td class="colFirst"><code><a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
203-
<td class="colLast"><span class="typeNameLabel">StagePosition.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/StagePosition.html#toPropertyMap--">toPropertyMap</a></span>()</code>
204-
<div class="block">Returns this StagePosition instance as a PropertyMap.</div>
203+
<td class="colLast"><span class="typeNameLabel">MultiStagePosition.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/MultiStagePosition.html#toPropertyMap--">toPropertyMap</a></span>()</code>
204+
<div class="block">Returns a propertymap describing this MultiStagePosition.</div>
205205
</td>
206206
</tr>
207207
<tr class="rowColor">
208208
<td class="colFirst"><code><a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
209-
<td class="colLast"><span class="typeNameLabel">MultiStagePosition.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/MultiStagePosition.html#toPropertyMap--">toPropertyMap</a></span>()</code>
210-
<div class="block">Returns a propertymap describing this MultiStagePosition.</div>
209+
<td class="colLast"><span class="typeNameLabel">StagePosition.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/StagePosition.html#toPropertyMap--">toPropertyMap</a></span>()</code>
210+
<div class="block">Returns this StagePosition instance as a PropertyMap.</div>
211211
</td>
212212
</tr>
213213
</tbody>
@@ -239,17 +239,17 @@ <h3>Uses of <a href="../../../org/micromanager/PropertyMap.html" title="interfac
239239
</tr>
240240
<tbody>
241241
<tr class="altColor">
242-
<td class="colFirst"><code>static <a href="../../../org/micromanager/StagePosition.html" title="class in org.micromanager">StagePosition</a></code></td>
243-
<td class="colLast"><span class="typeNameLabel">StagePosition.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/StagePosition.html#fromPropertyMap-org.micromanager.PropertyMap-">fromPropertyMap</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;pmap)</code>
244-
<div class="block">Returns the given PrropertyMap as a StagePosition.</div>
245-
</td>
246-
</tr>
247-
<tr class="rowColor">
248242
<td class="colFirst"><code>static <a href="../../../org/micromanager/MultiStagePosition.html" title="class in org.micromanager">MultiStagePosition</a></code></td>
249243
<td class="colLast"><span class="typeNameLabel">MultiStagePosition.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/MultiStagePosition.html#fromPropertyMap-org.micromanager.PropertyMap-">fromPropertyMap</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;pmap)</code>
250244
<div class="block">Generates a multistagePosition from the given PropertyMap.</div>
251245
</td>
252246
</tr>
247+
<tr class="rowColor">
248+
<td class="colFirst"><code>static <a href="../../../org/micromanager/StagePosition.html" title="class in org.micromanager">StagePosition</a></code></td>
249+
<td class="colLast"><span class="typeNameLabel">StagePosition.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/StagePosition.html#fromPropertyMap-org.micromanager.PropertyMap-">fromPropertyMap</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;pmap)</code>
250+
<div class="block">Returns the given PrropertyMap as a StagePosition.</div>
251+
</td>
252+
</tr>
253253
<tr class="altColor">
254254
<td class="colFirst"><code><a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
255255
<td class="colLast"><span class="typeNameLabel">PropertyMap.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/PropertyMap.html#getPropertyMap-java.lang.String-org.micromanager.PropertyMap-">getPropertyMap</a></span>(java.lang.String&nbsp;key,
@@ -356,14 +356,14 @@ <h3>Uses of <a href="../../../org/micromanager/PropertyMap.html" title="interfac
356356
</tr>
357357
<tr class="altColor">
358358
<td class="colFirst"><code><a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
359-
<td class="colLast"><span class="typeNameLabel">Metadata.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/data/Metadata.html#getUserData--">getUserData</a></span>()</code>
360-
<div class="block">Arbitrary additional metadata added by third-party code.</div>
359+
<td class="colLast"><span class="typeNameLabel">SummaryMetadata.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/data/SummaryMetadata.html#getUserData--">getUserData</a></span>()</code>
360+
<div class="block">Any general-purpose user meta data.</div>
361361
</td>
362362
</tr>
363363
<tr class="rowColor">
364364
<td class="colFirst"><code><a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
365-
<td class="colLast"><span class="typeNameLabel">SummaryMetadata.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/data/SummaryMetadata.html#getUserData--">getUserData</a></span>()</code>
366-
<div class="block">Any general-purpose user meta data.</div>
365+
<td class="colLast"><span class="typeNameLabel">Metadata.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/data/Metadata.html#getUserData--">getUserData</a></span>()</code>
366+
<div class="block">Arbitrary additional metadata added by third-party code.</div>
367367
</td>
368368
</tr>
369369
<tr class="altColor">
@@ -431,24 +431,24 @@ <h3>Uses of <a href="../../../org/micromanager/PropertyMap.html" title="interfac
431431
</td>
432432
</tr>
433433
<tr class="rowColor">
434-
<td class="colFirst"><code><a href="../../../org/micromanager/data/Metadata.Builder.html" title="interface in org.micromanager.data">Metadata.Builder</a></code></td>
435-
<td class="colLast"><span class="typeNameLabel">Metadata.Builder.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/data/Metadata.Builder.html#userData-org.micromanager.PropertyMap-">userData</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;userData)</code>
436-
<div class="block">Add user-defined data.</div>
437-
</td>
434+
<td class="colFirst"><code><a href="../../../org/micromanager/data/SummaryMetadata.Builder.html" title="interface in org.micromanager.data">SummaryMetadata.Builder</a></code></td>
435+
<td class="colLast"><span class="typeNameLabel">SummaryMetadata.Builder.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/data/SummaryMetadata.Builder.html#userData-org.micromanager.PropertyMap-">userData</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;userData)</code>&nbsp;</td>
438436
</tr>
439437
<tr class="altColor">
440-
<td class="colFirst"><code><a href="../../../org/micromanager/data/Metadata.MetadataBuilder.html" title="interface in org.micromanager.data">Metadata.MetadataBuilder</a></code></td>
441-
<td class="colLast"><span class="typeNameLabel">Metadata.MetadataBuilder.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/data/Metadata.MetadataBuilder.html#userData-org.micromanager.PropertyMap-">userData</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;userData)</code>
438+
<td class="colFirst"><code><a href="../../../org/micromanager/data/SummaryMetadata.SummaryMetadataBuilder.html" title="interface in org.micromanager.data">SummaryMetadata.SummaryMetadataBuilder</a></code></td>
439+
<td class="colLast"><span class="typeNameLabel">SummaryMetadata.SummaryMetadataBuilder.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/data/SummaryMetadata.SummaryMetadataBuilder.html#userData-org.micromanager.PropertyMap-">userData</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;userData)</code>
442440
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
443441
&nbsp;</td>
444442
</tr>
445443
<tr class="rowColor">
446-
<td class="colFirst"><code><a href="../../../org/micromanager/data/SummaryMetadata.Builder.html" title="interface in org.micromanager.data">SummaryMetadata.Builder</a></code></td>
447-
<td class="colLast"><span class="typeNameLabel">SummaryMetadata.Builder.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/data/SummaryMetadata.Builder.html#userData-org.micromanager.PropertyMap-">userData</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;userData)</code>&nbsp;</td>
444+
<td class="colFirst"><code><a href="../../../org/micromanager/data/Metadata.Builder.html" title="interface in org.micromanager.data">Metadata.Builder</a></code></td>
445+
<td class="colLast"><span class="typeNameLabel">Metadata.Builder.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/data/Metadata.Builder.html#userData-org.micromanager.PropertyMap-">userData</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;userData)</code>
446+
<div class="block">Add user-defined data.</div>
447+
</td>
448448
</tr>
449449
<tr class="altColor">
450-
<td class="colFirst"><code><a href="../../../org/micromanager/data/SummaryMetadata.SummaryMetadataBuilder.html" title="interface in org.micromanager.data">SummaryMetadata.SummaryMetadataBuilder</a></code></td>
451-
<td class="colLast"><span class="typeNameLabel">SummaryMetadata.SummaryMetadataBuilder.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/data/SummaryMetadata.SummaryMetadataBuilder.html#userData-org.micromanager.PropertyMap-">userData</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;userData)</code>
450+
<td class="colFirst"><code><a href="../../../org/micromanager/data/Metadata.MetadataBuilder.html" title="interface in org.micromanager.data">Metadata.MetadataBuilder</a></code></td>
451+
<td class="colLast"><span class="typeNameLabel">Metadata.MetadataBuilder.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/data/Metadata.MetadataBuilder.html#userData-org.micromanager.PropertyMap-">userData</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;userData)</code>
452452
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
453453
&nbsp;</td>
454454
</tr>
@@ -468,13 +468,13 @@ <h3>Uses of <a href="../../../org/micromanager/PropertyMap.html" title="interfac
468468
<tbody>
469469
<tr class="altColor">
470470
<td class="colFirst"><code><a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
471-
<td class="colLast"><span class="typeNameLabel">Overlay.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/display/overlay/Overlay.html#getConfiguration--">getConfiguration</a></span>()</code>
471+
<td class="colLast"><span class="typeNameLabel">AbstractOverlay.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/display/overlay/AbstractOverlay.html#getConfiguration--">getConfiguration</a></span>()</code>
472472
<div class="block">Return the user-customizable settings for this overlay.</div>
473473
</td>
474474
</tr>
475475
<tr class="rowColor">
476476
<td class="colFirst"><code><a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
477-
<td class="colLast"><span class="typeNameLabel">AbstractOverlay.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/display/overlay/AbstractOverlay.html#getConfiguration--">getConfiguration</a></span>()</code>
477+
<td class="colLast"><span class="typeNameLabel">Overlay.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/display/overlay/Overlay.html#getConfiguration--">getConfiguration</a></span>()</code>
478478
<div class="block">Return the user-customizable settings for this overlay.</div>
479479
</td>
480480
</tr>
@@ -489,13 +489,13 @@ <h3>Uses of <a href="../../../org/micromanager/PropertyMap.html" title="interfac
489489
<tbody>
490490
<tr class="altColor">
491491
<td class="colFirst"><code>void</code></td>
492-
<td class="colLast"><span class="typeNameLabel">Overlay.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/display/overlay/Overlay.html#setConfiguration-org.micromanager.PropertyMap-">setConfiguration</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;config)</code>
492+
<td class="colLast"><span class="typeNameLabel">AbstractOverlay.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/display/overlay/AbstractOverlay.html#setConfiguration-org.micromanager.PropertyMap-">setConfiguration</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;config)</code>
493493
<div class="block">Configure the overlay with the given parameters.</div>
494494
</td>
495495
</tr>
496496
<tr class="rowColor">
497497
<td class="colFirst"><code>void</code></td>
498-
<td class="colLast"><span class="typeNameLabel">AbstractOverlay.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/display/overlay/AbstractOverlay.html#setConfiguration-org.micromanager.PropertyMap-">setConfiguration</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;config)</code>
498+
<td class="colLast"><span class="typeNameLabel">Overlay.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/display/overlay/Overlay.html#setConfiguration-org.micromanager.PropertyMap-">setConfiguration</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;config)</code>
499499
<div class="block">Configure the overlay with the given parameters.</div>
500500
</td>
501501
</tr>

0 commit comments

Comments
 (0)