|
| 1 | +<!DOCTYPE html> |
| 2 | +<html> |
| 3 | + <head> |
| 4 | + <meta charset="utf-8"> |
| 5 | + <title>Interface IPolylineEncoder<TCoordinate, TPolyline> | Polyline Algorithm for .NET </title> |
| 6 | + <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| 7 | + <meta name="title" content="Interface IPolylineEncoder<TCoordinate, TPolyline> | Polyline Algorithm for .NET "> |
| 8 | + |
| 9 | + <meta name="description" content="Defines a contract for encoding a collection of geographic coordinates into an encoded polyline string."> |
| 10 | + <link rel="icon" href="../favicon.ico"> |
| 11 | + <link rel="stylesheet" href="../public/docfx.min.css"> |
| 12 | + <link rel="stylesheet" href="../public/main.css"> |
| 13 | + <meta name="docfx:navrel" content="../toc.html"> |
| 14 | + <meta name="docfx:tocrel" content="toc.html"> |
| 15 | + |
| 16 | + <meta name="docfx:rel" content="../"> |
| 17 | + |
| 18 | + |
| 19 | + <meta name="docfx:docurl" content="https://github.com/sramekpete/polyline-algorithm-csharp/new/develop/1.0/apiSpec/new?filename=PolylineAlgorithm_Abstraction_IPolylineEncoder_2.md&value=---%0Auid%3A%20PolylineAlgorithm.Abstraction.IPolylineEncoder%602%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A"> |
| 20 | + <meta name="loc:inThisArticle" content="In this article"> |
| 21 | + <meta name="loc:searchResultsCount" content="{count} results for "{query}""> |
| 22 | + <meta name="loc:searchNoResults" content="No results for "{query}""> |
| 23 | + <meta name="loc:tocFilter" content="Filter by title"> |
| 24 | + <meta name="loc:nextArticle" content="Next"> |
| 25 | + <meta name="loc:prevArticle" content="Previous"> |
| 26 | + <meta name="loc:themeLight" content="Light"> |
| 27 | + <meta name="loc:themeDark" content="Dark"> |
| 28 | + <meta name="loc:themeAuto" content="Auto"> |
| 29 | + <meta name="loc:changeTheme" content="Change theme"> |
| 30 | + <meta name="loc:copy" content="Copy"> |
| 31 | + <meta name="loc:downloadPdf" content="Download PDF"> |
| 32 | + |
| 33 | + <script type="module" src="./../public/docfx.min.js"></script> |
| 34 | + |
| 35 | + <script> |
| 36 | + const theme = localStorage.getItem('theme') || 'auto' |
| 37 | + document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme) |
| 38 | + </script> |
| 39 | + |
| 40 | + </head> |
| 41 | + |
| 42 | + <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference"> |
| 43 | + <header class="bg-body border-bottom"> |
| 44 | + <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> |
| 45 | + <div class="container-xxl flex-nowrap"> |
| 46 | + <a class="navbar-brand" href="../index.html"> |
| 47 | + <img id="logo" class="svg" src="../media/polyline-algorithm-50x46.png" alt=" Polyline Algorithm for .NET"> |
| 48 | + Polyline Algorithm for .NET |
| 49 | + </a> |
| 50 | + <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation"> |
| 51 | + <i class="bi bi-three-dots"></i> |
| 52 | + </button> |
| 53 | + <div class="collapse navbar-collapse" id="navpanel"> |
| 54 | + <div id="navbar"> |
| 55 | + <form class="search" role="search" id="search"> |
| 56 | + <i class="bi bi-search"></i> |
| 57 | + <input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search"> |
| 58 | + </form> |
| 59 | + </div> |
| 60 | + </div> |
| 61 | + </div> |
| 62 | + </nav> |
| 63 | + </header> |
| 64 | + |
| 65 | + <main class="container-xxl"> |
| 66 | + <div class="toc-offcanvas"> |
| 67 | + <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel"> |
| 68 | + <div class="offcanvas-header"> |
| 69 | + <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5> |
| 70 | + <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button> |
| 71 | + </div> |
| 72 | + <div class="offcanvas-body"> |
| 73 | + <nav class="toc" id="toc"></nav> |
| 74 | + </div> |
| 75 | + </div> |
| 76 | + </div> |
| 77 | + |
| 78 | + <div class="content"> |
| 79 | + <div class="actionbar"> |
| 80 | + <button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents"> |
| 81 | + <i class="bi bi-list"></i> |
| 82 | + </button> |
| 83 | + |
| 84 | + <nav id="breadcrumb"></nav> |
| 85 | + </div> |
| 86 | + |
| 87 | + <article data-uid="PolylineAlgorithm.Abstraction.IPolylineEncoder`2"> |
| 88 | + |
| 89 | + |
| 90 | + |
| 91 | + <h1 id="PolylineAlgorithm_Abstraction_IPolylineEncoder_2" data-uid="PolylineAlgorithm.Abstraction.IPolylineEncoder`2" class="text-break"> |
| 92 | +Interface IPolylineEncoder<TCoordinate, TPolyline> <a class="header-action link-secondary" title="View source" href="https://github.com/sramekpete/polyline-algorithm-csharp/blob/develop/1.0/src/PolylineAlgorithm.Abstraction/IPolylineEncoder.cs/#L13"><i class="bi bi-code-slash"></i></a> |
| 93 | + </h1> |
| 94 | + |
| 95 | + <div class="facts text-secondary"> |
| 96 | + <dl><dt>Namespace</dt><dd><a class="xref" href="PolylineAlgorithm.html">PolylineAlgorithm</a>.<a class="xref" href="PolylineAlgorithm.Abstraction.html">Abstraction</a></dd></dl> |
| 97 | + <dl><dt>Assembly</dt><dd>PolylineAlgorithm.Abstraction.dll</dd></dl> |
| 98 | + </div> |
| 99 | + |
| 100 | + <div class="markdown summary"><p>Defines a contract for encoding a collection of geographic coordinates into an encoded polyline string.</p> |
| 101 | +</div> |
| 102 | + <div class="markdown conceptual"></div> |
| 103 | + |
| 104 | + <div class="codewrapper"> |
| 105 | + <pre><code class="lang-csharp hljs">public interface IPolylineEncoder<TCoordinate, TPolyline></code></pre> |
| 106 | + </div> |
| 107 | + |
| 108 | + |
| 109 | + |
| 110 | + <h4 class="section">Type Parameters</h4> |
| 111 | + <dl class="parameters"> |
| 112 | + <dt><code>TCoordinate</code></dt> |
| 113 | + <dd></dd> |
| 114 | + <dt><code>TPolyline</code></dt> |
| 115 | + <dd></dd> |
| 116 | + </dl> |
| 117 | + |
| 118 | + |
| 119 | + |
| 120 | + |
| 121 | + |
| 122 | + |
| 123 | + |
| 124 | + |
| 125 | + |
| 126 | + |
| 127 | + <h2 class="section" id="methods">Methods |
| 128 | +</h2> |
| 129 | + |
| 130 | + |
| 131 | + <a id="PolylineAlgorithm_Abstraction_IPolylineEncoder_2_Encode_" data-uid="PolylineAlgorithm.Abstraction.IPolylineEncoder`2.Encode*"></a> |
| 132 | + |
| 133 | + <h3 id="PolylineAlgorithm_Abstraction_IPolylineEncoder_2_Encode_System_Collections_Generic_IEnumerable__0__" data-uid="PolylineAlgorithm.Abstraction.IPolylineEncoder`2.Encode(System.Collections.Generic.IEnumerable{`0})"> |
| 134 | + Encode(IEnumerable<TCoordinate>) |
| 135 | + <a class="header-action link-secondary" title="View source" href="https://github.com/sramekpete/polyline-algorithm-csharp/blob/develop/1.0/src/PolylineAlgorithm.Abstraction/IPolylineEncoder.cs/#L23"><i class="bi bi-code-slash"></i></a> |
| 136 | + </h3> |
| 137 | + |
| 138 | + <div class="markdown level1 summary"><p>Encodes a sequence of geographic coordinates into an encoded polyline representation.</p> |
| 139 | +</div> |
| 140 | + <div class="markdown level1 conceptual"></div> |
| 141 | + |
| 142 | + <div class="codewrapper"> |
| 143 | + <pre><code class="lang-csharp hljs">TPolyline Encode(IEnumerable<TCoordinate> coordinates)</code></pre> |
| 144 | + </div> |
| 145 | + |
| 146 | + <h4 class="section">Parameters</h4> |
| 147 | + <dl class="parameters"> |
| 148 | + <dt><code>coordinates</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><TCoordinate></dt> |
| 149 | + <dd><p>The collection of <code class="typeparamref">TCoordinate</code> instances to encode into a polyline.</p> |
| 150 | +</dd> |
| 151 | + </dl> |
| 152 | + |
| 153 | + <h4 class="section">Returns</h4> |
| 154 | + <dl class="parameters"> |
| 155 | + <dt><span class="xref">TPolyline</span></dt> |
| 156 | + <dd><p>A <code class="typeparamref">TPolyline</code> containing the encoded polyline string that represents the input coordinates.</p> |
| 157 | +</dd> |
| 158 | + </dl> |
| 159 | + |
| 160 | + |
| 161 | + |
| 162 | + |
| 163 | + |
| 164 | + |
| 165 | + |
| 166 | + |
| 167 | + |
| 168 | + |
| 169 | + |
| 170 | + |
| 171 | +</article> |
| 172 | + |
| 173 | + |
| 174 | + |
| 175 | + </div> |
| 176 | + |
| 177 | + <div class="affix"> |
| 178 | + <nav id="affix"></nav> |
| 179 | + </div> |
| 180 | + </main> |
| 181 | + |
| 182 | + <div class="container-xxl search-results" id="search-results"></div> |
| 183 | + |
| 184 | + <footer class="border-top text-secondary"> |
| 185 | + <div class="container-xxl"> |
| 186 | + <div class="flex-fill"> |
| 187 | + <span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span> |
| 188 | + </div> |
| 189 | + </div> |
| 190 | + </footer> |
| 191 | + </body> |
| 192 | +</html> |
0 commit comments