123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
-
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width, initial-scale=1">
- <title> Map</title>
- <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
- <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
- <script src="./build/entry.js"></script>
- <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
- <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
- <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
- <link type="text/css" rel="stylesheet" href="styles/app.min.css">
- <link type="text/css" rel="stylesheet" href="styles/iframe.css">
- <link type="text/css" rel="stylesheet" href="">
- <script async defer src="https://buttons.github.io/buttons.js"></script>
-
- </head>
- <body class="layout small-header">
- <div id="stickyNavbarOverlay"></div>
-
- <div class="top-nav">
- <div class="inner">
- <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
- <span aria-hidden="true"></span>
- <span aria-hidden="true"></span>
- <span aria-hidden="true"></span>
- </a>
- <div class="logo">
-
-
- </div>
- <div class="menu">
-
- <div class="navigation">
- <a
- href="index.html"
- class="link"
- >
- API Documentation
- </a>
-
-
-
- </div>
- </div>
- </div>
- </div>
- <div id="main">
- <div
- class="sidebar "
- id="sidebarNav"
- >
-
- <nav>
-
- <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Interfaces</h3><ul><li><a href="AddLandmarkProps.html">AddLandmarkProps</a></li><li><a href="CommentProps.html">CommentProps</a></li><li><a href="IdToken.html">IdToken</a></li><li><a href="IntroProps.html">IntroProps</a></li><li><a href="Landmark.html">Landmark</a></li><li><a href="LandmarkDetailsProps.html">LandmarkDetailsProps</a></li><li><a href="LandmarkPinProps.html">LandmarkPinProps</a></li><li><a href="LMComment.html">LMComment</a></li><li><a href="ProfileProps.html">ProfileProps</a></li><li><a href="RegisterProps.html">RegisterProps</a></li><li><a href="UserProfile.html">UserProfile</a></li></ul><h3>Components</h3><ul><li><a href="App.html">App</a></li><li><a href="Atlas.html">Atlas</a></li><li><a href="Comment.html">Comment</a></li><li><a href="PrimaryButton.html">PrimaryButton</a></li><li><a href="Profile.html">Profile</a></li><li><a href="SecondaryButton.html">SecondaryButton</a></li></ul><h3>Global</h3><ul><li><a href="global.html#IconStrings">IconStrings</a></li></ul></div><div class="category"><h2>Hooks</h2><h3>Namespaces</h3><ul><li><a href="useAuth.html">useAuth</a></li><li><a href="useLandmarks.html">useLandmarks</a></li><li><a href="useProfile.html">useProfile</a></li></ul></div><div class="category"><h2>Map</h2><h3>Interfaces</h3><ul><li><a href="UserLocation.html">UserLocation</a></li></ul><h3>Components</h3><ul><li><a href="AddLandmark.html">AddLandmark</a></li><li><a href="LandmarkDetails.html">LandmarkDetails</a></li><li><a href="LandmarkPin.html">LandmarkPin</a></li><li><a href="Map.html">Map</a></li></ul></div><div class="category"><h2>Navigation</h2><h3>Components</h3><ul><li><a href="AuthorizedNavigator.html">AuthorizedNavigator</a></li><li><a href="UnauthorizedNavigator.html">UnauthorizedNavigator</a></li></ul><h3><a href="global.html">Global</a></h3></div><div class="category"><h2>Stores</h2><h3>Classes</h3><ul><li><a href="AuthStore.html">AuthStore</a></li></ul></div><div class="category"><h2>Unauthorized</h2><h3>Components</h3><ul><li><a href="Intro.html">Intro</a></li><li><a href="UnauthorizedLayout.html">UnauthorizedLayout</a></li></ul><h3>Components / Registration</h3><ul><li><a href="RegisterMain.html">RegisterMain</a></li></ul></div>
-
- </nav>
- </div>
- <div class="core" id="main-content-wrapper">
- <div class="content">
- <header class="page-title">
- <p>Components</p>
- <h1>Map</h1>
- </header>
-
- <section>
- <header>
-
- <h2>
- <Map />
- </h2>
-
-
- </header>
- <article>
- <div class="container-overview">
-
-
- <div class='vertical-section'>
- <div class="members">
- <div class="member">
- <div class=name>
- <span class="tag">Constructor</span>
- </div>
-
-
- <h4 class="name" id="Map">
- <a class="href-link" href="#Map">#</a>
-
- <span class="code-name">
-
- <Map />
-
- </span>
- </h4>
-
-
-
- <div class="description">
- <p>The screen component containing the <a href="https://github.com/react-native-maps/react-native-maps">react-native-maps</a> Map and all related functionality.</p>
- </div>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <p class="tag-source">
- <a href="src_components_Map.tsx.html" class="button">View Source</a>
- <span>
- <a href="src_components_Map.tsx.html">src/components/Map.tsx</a>, <a href="src_components_Map.tsx.html#line19">line 19</a>
- </span>
- </p>
-
- </dl>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <div class='vertical-section'>
- <h1>Members</h1>
- <div class="members">
-
- <div class="member">
- <h4 class="name" id="~followUserState">
- <a class="href-link" href="#~followUserState">#</a>
-
-
- <span class='tag'>inner</span>
-
- <span class='tag'>constant</span>
-
-
- <span class="code-name">
- followUserState
- </span>
-
- </h4>
- <div class="description">
- <p>Flag that determines whether the map should focus and follow the user's location.</p>
- </div>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <p class="tag-source">
- <a href="src_components_Map.tsx.html" class="button">View Source</a>
- <span>
- <a href="src_components_Map.tsx.html">src/components/Map.tsx</a>, <a href="src_components_Map.tsx.html#line54">line 54</a>
- </span>
- </p>
-
- </dl>
- </div>
-
- <div class="member">
- <h4 class="name" id="~lmAddVisibleState">
- <a class="href-link" href="#~lmAddVisibleState">#</a>
-
-
- <span class='tag'>inner</span>
-
- <span class='tag'>constant</span>
-
-
- <span class="code-name">
- lmAddVisibleState
- </span>
-
- </h4>
- <div class="description">
- <p>Holds the visibility state of the <a href="AddLandmark.html">AddLandmark</a> modal.</p>
- </div>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <p class="tag-source">
- <a href="src_components_Map.tsx.html" class="button">View Source</a>
- <span>
- <a href="src_components_Map.tsx.html">src/components/Map.tsx</a>, <a href="src_components_Map.tsx.html#line33">line 33</a>
- </span>
- </p>
-
- </dl>
- </div>
-
- <div class="member">
- <h4 class="name" id="~lmDetailsEditingState">
- <a class="href-link" href="#~lmDetailsEditingState">#</a>
-
-
- <span class='tag'>inner</span>
-
- <span class='tag'>constant</span>
-
-
- <span class="code-name">
- lmDetailsEditingState
- </span>
-
- </h4>
- <div class="description">
- <p>Flag that toggles whether or not editing is enabled in the <a href="LandmarkDetails.html">LandmarkDetails</a> modal.
- The parent Map component has access to it so that it can disable closing the modal on backdrop press when it is enabled.</p>
- </div>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <p class="tag-source">
- <a href="src_components_Map.tsx.html" class="button">View Source</a>
- <span>
- <a href="src_components_Map.tsx.html">src/components/Map.tsx</a>, <a href="src_components_Map.tsx.html#line44">line 44</a>
- </span>
- </p>
-
- </dl>
- </div>
-
- <div class="member">
- <h4 class="name" id="~lmDetailsVisibleState">
- <a class="href-link" href="#~lmDetailsVisibleState">#</a>
-
-
- <span class='tag'>inner</span>
-
- <span class='tag'>constant</span>
-
-
- <span class="code-name">
- lmDetailsVisibleState
- </span>
-
- </h4>
- <div class="description">
- <p>Holds the visibility state of the <a href="LandmarkDetails.html">LandmarkDetails</a> modal.</p>
- </div>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <p class="tag-source">
- <a href="src_components_Map.tsx.html" class="button">View Source</a>
- <span>
- <a href="src_components_Map.tsx.html">src/components/Map.tsx</a>, <a href="src_components_Map.tsx.html#line38">line 38</a>
- </span>
- </p>
-
- </dl>
- </div>
-
- <div class="member">
- <h4 class="name" id="~mapRef">
- <a class="href-link" href="#~mapRef">#</a>
-
-
- <span class='tag'>inner</span>
-
- <span class='tag'>constant</span>
-
-
- <span class="code-name">
- mapRef
- </span>
-
- </h4>
- <div class="description">
- <p>Ref that holds the loaded <a href="https://github.com/react-native-maps/react-native-maps/blob/master/docs/mapview.md">MapView</a> instance.</p>
- </div>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <p class="tag-source">
- <a href="src_components_Map.tsx.html" class="button">View Source</a>
- <span>
- <a href="src_components_Map.tsx.html">src/components/Map.tsx</a>, <a href="src_components_Map.tsx.html#line61">line 61</a>
- </span>
- </p>
-
- </dl>
- </div>
-
- <div class="member">
- <h4 class="name" id="~newLandmarkState">
- <a class="href-link" href="#~newLandmarkState">#</a>
-
-
- <span class='tag'>inner</span>
-
- <span class='tag'>constant</span>
-
-
- <span class="code-name">
- newLandmarkState
- </span>
-
- </h4>
- <div class="description">
- <p>State that contains the new <a href="Landmark.html">Landmark</a> object which is passed down to the <a href="AddLandmark.html">AddLandmark</a> modal.</p>
- </div>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <p class="tag-source">
- <a href="src_components_Map.tsx.html" class="button">View Source</a>
- <span>
- <a href="src_components_Map.tsx.html">src/components/Map.tsx</a>, <a href="src_components_Map.tsx.html#line23">line 23</a>
- </span>
- </p>
-
- </dl>
- </div>
-
- <div class="member">
- <h4 class="name" id="~selectedLandmarkState">
- <a class="href-link" href="#~selectedLandmarkState">#</a>
-
-
- <span class='tag'>inner</span>
-
- <span class='tag'>constant</span>
-
-
- <span class="code-name">
- selectedLandmarkState
- </span>
-
- </h4>
- <div class="description">
- <p>State that contains the selected <a href="Landmark.html">Landmark</a> object which is passed down to the <a href="LandmarkDetails.html">LandmarkDetails</a> modal.</p>
- </div>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <p class="tag-source">
- <a href="src_components_Map.tsx.html" class="button">View Source</a>
- <span>
- <a href="src_components_Map.tsx.html">src/components/Map.tsx</a>, <a href="src_components_Map.tsx.html#line28">line 28</a>
- </span>
- </p>
-
- </dl>
- </div>
-
- <div class="member">
- <h4 class="name" id="~userLocationState">
- <a class="href-link" href="#~userLocationState">#</a>
-
-
- <span class='tag'>inner</span>
-
- <span class='tag'>constant</span>
-
-
- <span class="code-name">
- userLocationState
- </span>
-
- </h4>
- <div class="description">
- <p>State that holds a <a href="UserLocation.html">UserLocation</a> object retrieved from location services.</p>
- </div>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <p class="tag-source">
- <a href="src_components_Map.tsx.html" class="button">View Source</a>
- <span>
- <a href="src_components_Map.tsx.html">src/components/Map.tsx</a>, <a href="src_components_Map.tsx.html#line49">line 49</a>
- </span>
- </p>
-
- </dl>
- </div>
-
- </div>
- </div>
-
-
- <div class='vertical-section'>
- <h1>Methods</h1>
- <div class="members">
-
- <div class="member">
-
- <h4 class="name" id=".openAddLandmark">
- <a class="href-link" href="#.openAddLandmark">#</a>
-
-
- <span class='tag'>static</span>
-
-
- <span class="code-name">
-
- openAddLandmark<span class="signature">()</span><span class="type-signature"></span>
-
- </span>
- </h4>
-
-
-
- <div class="description">
- <p>Opens the <a href="AddLandmark.html">AddLandmark</a> modal when the user creates newLandmarkState by longpressing the map.
- Embedded in a <a href="https://reactjs.org/docs/hooks-effect.html">useEffect</a> hook that listens to <code>newLandmarkState</code>.</p>
- </div>
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <p class="tag-source">
- <a href="src_components_Map.tsx.html" class="button">View Source</a>
- <span>
- <a href="src_components_Map.tsx.html">src/components/Map.tsx</a>, <a href="src_components_Map.tsx.html#line98">line 98</a>
- </span>
- </p>
-
- </dl>
- </div>
-
- <div class="member">
-
- <h4 class="name" id=".requestLocationPermissions">
- <a class="href-link" href="#.requestLocationPermissions">#</a>
-
-
- <span class='tag'>async</span>
-
- <span class='tag'>static</span>
-
-
- <span class="code-name">
-
- requestLocationPermissions<span class="signature">()</span><span class="type-signature"></span>
-
- </span>
- </h4>
-
-
-
- <div class="description">
- <p>Prompts user to give permission to track their location using <a href="https://docs.expo.dev/versions/latest/sdk/location/">expo-location</a>.
- If permission is granted, user location will be retrieved and stored in <code>userLocationState</code>.</p>
- </div>
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <p class="tag-source">
- <a href="src_components_Map.tsx.html" class="button">View Source</a>
- <span>
- <a href="src_components_Map.tsx.html">src/components/Map.tsx</a>, <a href="src_components_Map.tsx.html#line68">line 68</a>
- </span>
- </p>
-
- </dl>
- </div>
-
- <div class="member">
-
- <h4 class="name" id="~flyToUser">
- <a class="href-link" href="#~flyToUser">#</a>
-
-
- <span class='tag'>inner</span>
-
-
- <span class="code-name">
-
- flyToUser<span class="signature">()</span><span class="type-signature"></span>
-
- </span>
- </h4>
-
-
-
- <div class="description">
- <p>Animates the map to fly over to and focus on the user's location.</p>
- </div>
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <p class="tag-source">
- <a href="src_components_Map.tsx.html" class="button">View Source</a>
- <span>
- <a href="src_components_Map.tsx.html">src/components/Map.tsx</a>, <a href="src_components_Map.tsx.html#line123">line 123</a>
- </span>
- </p>
-
- </dl>
- </div>
-
- <div class="member">
-
- <h4 class="name" id="~focusLandmark">
- <a class="href-link" href="#~focusLandmark">#</a>
-
-
- <span class='tag'>inner</span>
-
-
- <span class="code-name">
-
- focusLandmark<span class="signature">()</span><span class="type-signature"></span>
-
- </span>
- </h4>
-
-
-
- <div class="description">
- <p>Triggered by on a <a href="Landmark.html">Landmark</a> displayed on the map.
- Sets <code>selectedLandmark</code> to the pressed <a href="Landmark.html">Landmark</a> object's value and toggles the <a href="LandmarkDetails.html">LandmarkDetails</a> modal.</p>
- </div>
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <p class="tag-source">
- <a href="src_components_Map.tsx.html" class="button">View Source</a>
- <span>
- <a href="src_components_Map.tsx.html">src/components/Map.tsx</a>, <a href="src_components_Map.tsx.html#line116">line 116</a>
- </span>
- </p>
-
- </dl>
- </div>
-
- <div class="member">
-
- <h4 class="name" id="~promptAddLandmark">
- <a class="href-link" href="#~promptAddLandmark">#</a>
-
-
- <span class='tag'>inner</span>
-
-
- <span class="code-name">
-
- promptAddLandmark<span class="signature">()</span><span class="type-signature"></span>
-
- </span>
- </h4>
-
-
-
- <div class="description">
- <p>Triggered by long pressing on the map.
- Sets <code>newLandmarkState</code> to a skeleton <a href="Landmark.html">Landmark</a> object that only contains the pressed coordinates.
- Triggers openAddLandmark via useEffect because the asyncronous nature of useState does not set the coordinates fast enough to toggle the modal directly through this method.</p>
- </div>
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <p class="tag-source">
- <a href="src_components_Map.tsx.html" class="button">View Source</a>
- <span>
- <a href="src_components_Map.tsx.html">src/components/Map.tsx</a>, <a href="src_components_Map.tsx.html#line89">line 89</a>
- </span>
- </p>
-
- </dl>
- </div>
-
- </div>
- </div>
-
-
-
- </article>
- </section>
- </div>
-
- <footer class="footer">
- <div class="content has-text-centered">
- <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a></p>
- <p class="sidebar-created-by">
- <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
- <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
- </p>
- </div>
- </footer>
-
- </div>
- <div id="side-nav" class="side-nav">
- </div>
- </div>
- <script src="scripts/app.min.js"></script>
- <script>PR.prettyPrint();</script>
- <script src="scripts/linenumber.js"> </script>
- </body>
- </html>
|