Peter 9bc996374f Add 'submodules/AsyncDisplayKit/' from commit '02bedc12816e251ad71777f9d2578329b6d2bef6'
git-subtree-dir: submodules/AsyncDisplayKit
git-subtree-mainline: d06f423e0ed3df1fed9bd10d79ee312a9179b632
git-subtree-split: 02bedc12816e251ad71777f9d2578329b6d2bef6
2019-06-11 18:42:43 +01:00

531 lines
12 KiB
HTML
Executable File

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>ASMapNode Class Reference</title>
<link rel="stylesheet" href="../css/style.css">
<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
<meta name="generator" content="appledoc 2.2.1 (build 1334)">
</head>
<body class="appledoc">
<header>
<div class="container" class="hide-in-xcode">
<h1 id="library-title">
<a href="../index.html"> </a>
</h1>
<p id="developer-home">
<a href="../index.html">AsyncDisplayKit</a>
</p>
</div>
</header>
<aside>
<div class="container">
<nav>
<ul id="header-buttons" role="toolbar">
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
<li id="on-this-page" role="navigation">
<label>
On This Page
<div class="chevron">
<div class="chevy chevron-left"></div>
<div class="chevy chevron-right"></div>
</div>
<select id="jump-to">
<option value="top">Jump To&#133;</option>
<option value="tasks">Tasks</option>
<optgroup label="Properties">
<option value="//api/name/annotations">annotations</option>
<option value="//api/name/imageForStaticMapAnnotationBlock">imageForStaticMapAnnotationBlock</option>
<option value="//api/name/liveMap">liveMap</option>
<option value="//api/name/mapDelegate">mapDelegate</option>
<option value="//api/name/mapView">mapView</option>
<option value="//api/name/needsMapReloadOnBoundsChange">needsMapReloadOnBoundsChange</option>
<option value="//api/name/options">options</option>
<option value="//api/name/region">region</option>
<option value="//api/name/showAnnotationsOptions">showAnnotationsOptions</option>
</optgroup>
</select>
</label>
</li>
</ul>
</nav>
</div>
</aside>
<article>
<div id="overview_contents" class="container">
<div id="content">
<main role="main">
<h1 class="title">ASMapNode Class Reference</h1>
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<th>Inherits from</th>
<td><a href="../Classes/ASImageNode.html">ASImageNode</a> : <a href="../Classes/ASControlNode.html">ASControlNode</a> : <a href="../Classes/ASDisplayNode.html">ASDisplayNode</a> : ASDealloc2MainObject</td>
</tr><tr>
<th>Declared in</th>
<td>ASMapNode.h</td>
</tr>
</tbody></table></div>
<div class="section section-tasks">
<a title="Tasks" name="tasks"></a>
<div class="task-list">
<div class="section-method">
<a name="//api/name/options" title="options"></a>
<h3 class="method-title"><code><a href="#//api/name/options">&nbsp;&nbsp;options</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>The current options of ASMapNode. This can be set at any time and ASMapNode will animate the change.<br><br>This property may be set from a background thread before the node is loaded, and will automatically be applied to define the behavior of the static snapshot (if .liveMap = NO) or the internal MKMapView (otherwise).<br><br> Changes to the region and camera options will only be animated when when the liveMap mode is enabled, otherwise these options will be applied statically to the new snapshot. <br><br> The options object is used to specify properties even when the liveMap mode is enabled, allowing seamless transitions between the snapshot and liveMap (as well as back to the snapshot).</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, strong) MKMapSnapshotOptions *options</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMapNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/region" title="region"></a>
<h3 class="method-title"><code><a href="#//api/name/region">&nbsp;&nbsp;region</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>The region is simply the sub-field on the options object. If the objects object is reset,
this will in effect be overwritten and become the value of the .region property on that object.
Defaults to MKCoordinateRegionForMapRect(MKMapRectWorld).</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) MKCoordinateRegion region</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMapNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/mapView" title="mapView"></a>
<h3 class="method-title"><code><a href="#//api/name/mapView">&nbsp;&nbsp;mapView</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>This is the MKMapView that is the live map part of ASMapNode. This will be nil if .liveMap = NO. Note, MKMapView is <em>not</em> thread-safe.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nullable, nonatomic, readonly) MKMapView *mapView</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMapNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/liveMap" title="liveMap"></a>
<h3 class="method-title"><code><a href="#//api/name/liveMap">&nbsp;&nbsp;liveMap</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Set this to YES to turn the snapshot into an interactive MKMapView and vice versa. Defaults to NO. This property may be set on a background thread before the node is loaded, and will automatically be actioned, once the node is loaded.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, getter=isLiveMap) BOOL liveMap</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMapNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/needsMapReloadOnBoundsChange" title="needsMapReloadOnBoundsChange"></a>
<h3 class="method-title"><code><a href="#//api/name/needsMapReloadOnBoundsChange">&nbsp;&nbsp;needsMapReloadOnBoundsChange</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Whether ASMapNode should automatically request a new map snapshot to correspond to the new node size.
@default Default value is YES.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) BOOL needsMapReloadOnBoundsChange</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>If mapSize is set then this will be set to NO, since the size will be the same in all orientations.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMapNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/mapDelegate" title="mapDelegate"></a>
<h3 class="method-title"><code><a href="#//api/name/mapDelegate">&nbsp;&nbsp;mapDelegate</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Set the delegate of the MKMapView. This can be set even before mapView is created and will be set on the map in the case that the liveMap mode is engaged.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, weak) id&lt;MKMapViewDelegate&gt; mapDelegate</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMapNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/annotations" title="annotations"></a>
<h3 class="method-title"><code><a href="#//api/name/annotations">&nbsp;&nbsp;annotations</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>The annotations to display on the map.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, copy) NSArray&lt;id&lt;MKAnnotation&gt; &gt; *annotations</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMapNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/showAnnotationsOptions" title="showAnnotationsOptions"></a>
<h3 class="method-title"><code><a href="#//api/name/showAnnotationsOptions">&nbsp;&nbsp;showAnnotationsOptions</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>This property specifies how to show the annotations.
@default Default value is ASMapNodeShowAnnotationsIgnored</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) ASMapNodeShowAnnotationsOptions showAnnotationsOptions</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMapNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/imageForStaticMapAnnotationBlock" title="imageForStaticMapAnnotationBlock"></a>
<h3 class="method-title"><code><a href="#//api/name/imageForStaticMapAnnotationBlock">&nbsp;&nbsp;imageForStaticMapAnnotationBlock</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>The block which should return annotation image for static map based on provided annotation.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, copy, nullable) UIImage *( ^ ) ( id&lt;MKAnnotation&gt; annotation , CGPoint *centerOffset ) imageForStaticMapAnnotationBlock</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>This block is executed on an arbitrary serial queue. If this block is nil, standard pin is used.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMapNode.h</code></p>
</div>
</div>
</div>
</div>
</div>
</div>
</main>
<footer>
<div class="footer-copyright">
<p class="copyright">Copyright &copy; 2016 AsyncDisplayKit. All rights reserved. Updated: 2016-11-05</p>
<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>
</div>
</footer>
</div>
</div>
</article>
<script src="../js/script.js"></script>
</body>
</html>