apps
/
atlas-mobile-ts


			
							1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111
							<!DOCTYPE html>
<html lang="en">

<head>
  
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title> LandmarkDetails</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>LandmarkDetails</h1>
                </header>
                

<section>

<header>
    
        <h2>
            &ltLandmarkDetails  /&gt
        </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="LandmarkDetails">
        <a class="href-link" href="#LandmarkDetails">#</a>
        
        <span class="code-name">
            
                &ltLandmarkDetails  /&gt
            
        </span>
    </h4>
    

    <div class="description">
        <p>Component that renders the details of a selected <a href="Landmark.html">Landmark</a> and allows the user to edit those details. Contained within a <a href="https://github.com/react-native-modal/react-native-modal">react-native-modal</a>.</p>
    </div>
    

<dl class="details">

    
        <p class="tag-source">
            <a href="src_components_LandmarkDetails.tsx.html" class="button">View Source</a>
            <span>
                <a href="src_components_LandmarkDetails.tsx.html">src/components/LandmarkDetails.tsx</a>, <a href="src_components_LandmarkDetails.tsx.html#line22">line 22</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="~renderComment">
    <a class="href-link" href="#~renderComment">#</a>
    
        
            <span class='tag'>inner</span>
        
            <span class='tag'>constant</span>
        
    
    <span class="code-name">
        renderComment
    </span>
    
</h4>


<div class="description">
    <p>Renders all <a href="LMComment.html">comments</a> associated with the <code>selectedLandmark</code> as items for the <a href="https://reactnative.dev/docs/flatlist">FlatList</a> in this component.</p>
</div>


<dl class="details">

    
        <p class="tag-source">
            <a href="src_components_LandmarkDetails.tsx.html" class="button">View Source</a>
            <span>
                <a href="src_components_LandmarkDetails.tsx.html">src/components/LandmarkDetails.tsx</a>, <a href="src_components_LandmarkDetails.tsx.html#line103">line 103</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>Holds the state of the <a href="Landmark.html">Landmark</a> being displayed.</p>
</div>


<dl class="details">

    
        <p class="tag-source">
            <a href="src_components_LandmarkDetails.tsx.html" class="button">View Source</a>
            <span>
                <a href="src_components_LandmarkDetails.tsx.html">src/components/LandmarkDetails.tsx</a>, <a href="src_components_LandmarkDetails.tsx.html#line26">line 26</a>
            </span>
        </p>
    
</dl>


</div>
            
                <div class="member">

<h4 class="name" id="~updatedLandmarkState">
    <a class="href-link" href="#~updatedLandmarkState">#</a>
    
        
            <span class='tag'>inner</span>
        
            <span class='tag'>constant</span>
        
    
    <span class="code-name">
        updatedLandmarkState
    </span>
    
</h4>


<div class="description">
    <p>Holds state of a <a href="Landmark.html">Landmark</a> object parallel to <code>selectedLandmarkState</code> that is manipulated when <code>editingEnabled</code> is true.</p>
</div>


<dl class="details">

    
        <p class="tag-source">
            <a href="src_components_LandmarkDetails.tsx.html" class="button">View Source</a>
            <span>
                <a href="src_components_LandmarkDetails.tsx.html">src/components/LandmarkDetails.tsx</a>, <a href="src_components_LandmarkDetails.tsx.html#line31">line 31</a>
            </span>
        </p>
    
</dl>


</div>
            
            </div>
        </div>
    

        <div class='vertical-section'>
            <h1>Methods</h1>
            <div class="members">
            
                <div class="member">


    <h4 class="name" id=".resetDeleteMutationOnSuccess">
        <a class="href-link" href="#.resetDeleteMutationOnSuccess">#</a>
        
            
                <span class='tag'>static</span>
            
        
        <span class="code-name">
            
                resetDeleteMutationOnSuccess<span class="signature">()</span><span class="type-signature"></span>
            
        </span>
    </h4>
    

    <div class="description">
        <p>Resets the <code>deleteLandmark</code> mutation on successful delete.
Embedded in a useEffect that listens to the <code>deleteLandmarkStatus</code> value from the <a href="useLandmarks.html">useLandmarks</a> hook.</p>
    </div>
    

<dl class="details">

    
        <p class="tag-source">
            <a href="src_components_LandmarkDetails.tsx.html" class="button">View Source</a>
            <span>
                <a href="src_components_LandmarkDetails.tsx.html">src/components/LandmarkDetails.tsx</a>, <a href="src_components_LandmarkDetails.tsx.html#line65">line 65</a>
            </span>
        </p>
    
</dl>


</div>
            
                <div class="member">


    <h4 class="name" id=".resetUpdateMutationOnSuccess">
        <a class="href-link" href="#.resetUpdateMutationOnSuccess">#</a>
        
            
                <span class='tag'>static</span>
            
        
        <span class="code-name">
            
                resetUpdateMutationOnSuccess<span class="signature">()</span><span class="type-signature"></span>
            
        </span>
    </h4>
    

    <div class="description">
        <p>Resets the <code>updateLandmark</code> mutation on successful add.
Embedded in a useEffect that listens to the <code>updateLandmarkStatus</code> value from the <a href="useLandmarks.html">useLandmarks</a> hook.</p>
    </div>
    

<dl class="details">

    
        <p class="tag-source">
            <a href="src_components_LandmarkDetails.tsx.html" class="button">View Source</a>
            <span>
                <a href="src_components_LandmarkDetails.tsx.html">src/components/LandmarkDetails.tsx</a>, <a href="src_components_LandmarkDetails.tsx.html#line51">line 51</a>
            </span>
        </p>
    
</dl>


</div>
            
                <div class="member">


    <h4 class="name" id=".updateLandmarkStateFromParent">
        <a class="href-link" href="#.updateLandmarkStateFromParent">#</a>
        
            
                <span class='tag'>static</span>
            
        
        <span class="code-name">
            
                updateLandmarkStateFromParent<span class="signature">()</span><span class="type-signature"></span>
            
        </span>
    </h4>
    

    <div class="description">
        <p>Updates this component's <code>selectedLandmarkState</code> when the <code>landmark</code> prop passed down from the parent <a href="Map.html">Map</a>'s <code>selectedLandmark</code> is changed.
Embedded in a useEffect that listens to the <code>landmark</code> prop.</p>
    </div>
    

<dl class="details">

    
        <p class="tag-source">
            <a href="src_components_LandmarkDetails.tsx.html" class="button">View Source</a>
            <span>
                <a href="src_components_LandmarkDetails.tsx.html">src/components/LandmarkDetails.tsx</a>, <a href="src_components_LandmarkDetails.tsx.html#line40">line 40</a>
            </span>
        </p>
    
</dl>


</div>
            
                <div class="member">


    <h4 class="name" id="~editLandmark">
        <a class="href-link" href="#~editLandmark">#</a>
        
            
                <span class='tag'>async</span>
            
                <span class='tag'>inner</span>
            
        
        <span class="code-name">
            
                editLandmark<span class="signature">()</span><span class="type-signature"></span>
            
        </span>
    </h4>
    

    <div class="description">
        <p>Calls the <code>updateLandmark</code> mutation from the <a href="useLandmarks.html">useLandmarks</a> hook and closes the modal once finished.</p>
    </div>
    

<dl class="details">

    
        <p class="tag-source">
            <a href="src_components_LandmarkDetails.tsx.html" class="button">View Source</a>
            <span>
                <a href="src_components_LandmarkDetails.tsx.html">src/components/LandmarkDetails.tsx</a>, <a href="src_components_LandmarkDetails.tsx.html#line87">line 87</a>
            </span>
        </p>
    
</dl>


</div>
            
                <div class="member">


    <h4 class="name" id="~removeLandmark">
        <a class="href-link" href="#~removeLandmark">#</a>
        
            
                <span class='tag'>async</span>
            
                <span class='tag'>inner</span>
            
        
        <span class="code-name">
            
                removeLandmark<span class="signature">()</span><span class="type-signature"></span>
            
        </span>
    </h4>
    

    <div class="description">
        <p>Calls the <code>deleteLandmark</code> mutation from the <a href="useLandmarks.html">useLandmarks</a> hook and closes the modal once finished.</p>
    </div>
    

<dl class="details">

    
        <p class="tag-source">
            <a href="src_components_LandmarkDetails.tsx.html" class="button">View Source</a>
            <span>
                <a href="src_components_LandmarkDetails.tsx.html">src/components/LandmarkDetails.tsx</a>, <a href="src_components_LandmarkDetails.tsx.html#line96">line 96</a>
            </span>
        </p>
    
</dl>


</div>
            
                <div class="member">


    <h4 class="name" id="~toggleEditing">
        <a class="href-link" href="#~toggleEditing">#</a>
        
            
                <span class='tag'>inner</span>
            
        
        <span class="code-name">
            
                toggleEditing<span class="signature">()</span><span class="type-signature"></span>
            
        </span>
    </h4>
    

    <div class="description">
        <p>Toggles whether or not the <code>selectedLandmark</code> can be edited through the <code>editingEnabled</code> prop.</p>
    </div>
    

<dl class="details">

    
        <p class="tag-source">
            <a href="src_components_LandmarkDetails.tsx.html" class="button">View Source</a>
            <span>
                <a href="src_components_LandmarkDetails.tsx.html">src/components/LandmarkDetails.tsx</a>, <a href="src_components_LandmarkDetails.tsx.html#line75">line 75</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>