22 |
23 | The MGRS Javascript library was developed by the National Geospatial-Intelligence Agency (NGA) in collaboration with BIT Systems.
24 |
25 |
MGRS is a Javascript library providing Military Grid Reference System functionality, a geocoordinate standard used by NATO militaries for locating points on Earth.
26 |
27 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
--------------------------------------------------------------------------------
/docs/stylesheets/github-light.css:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright 2014 GitHub Inc.
3 |
4 | Licensed under the Apache License, Version 2.0 (the "License");
5 | you may not use this file except in compliance with the License.
6 | You may obtain a copy of the License at
7 |
8 | http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS,
12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | See the License for the specific language governing permissions and
14 | limitations under the License.
15 |
16 | */
17 |
18 | .pl-c /* comment */ {
19 | color: #969896;
20 | }
21 |
22 | .pl-c1 /* constant, markup.raw, meta.diff.header, meta.module-reference, meta.property-name, support, support.constant, support.variable, variable.other.constant */,
23 | .pl-s .pl-v /* string variable */ {
24 | color: #0086b3;
25 | }
26 |
27 | .pl-e /* entity */,
28 | .pl-en /* entity.name */ {
29 | color: #795da3;
30 | }
31 |
32 | .pl-s .pl-s1 /* string source */,
33 | .pl-smi /* storage.modifier.import, storage.modifier.package, storage.type.java, variable.other, variable.parameter.function */ {
34 | color: #333;
35 | }
36 |
37 | .pl-ent /* entity.name.tag */ {
38 | color: #63a35c;
39 | }
40 |
41 | .pl-k /* keyword, storage, storage.type */ {
42 | color: #a71d5d;
43 | }
44 |
45 | .pl-pds /* punctuation.definition.string, string.regexp.character-class */,
46 | .pl-s /* string */,
47 | .pl-s .pl-pse .pl-s1 /* string punctuation.section.embedded source */,
48 | .pl-sr /* string.regexp */,
49 | .pl-sr .pl-cce /* string.regexp constant.character.escape */,
50 | .pl-sr .pl-sra /* string.regexp string.regexp.arbitrary-repitition */,
51 | .pl-sr .pl-sre /* string.regexp source.ruby.embedded */ {
52 | color: #183691;
53 | }
54 |
55 | .pl-v /* variable */ {
56 | color: #ed6a43;
57 | }
58 |
59 | .pl-id /* invalid.deprecated */ {
60 | color: #b52a1d;
61 | }
62 |
63 | .pl-ii /* invalid.illegal */ {
64 | background-color: #b52a1d;
65 | color: #f8f8f8;
66 | }
67 |
68 | .pl-sr .pl-cce /* string.regexp constant.character.escape */ {
69 | color: #63a35c;
70 | font-weight: bold;
71 | }
72 |
73 | .pl-ml /* markup.list */ {
74 | color: #693a17;
75 | }
76 |
77 | .pl-mh /* markup.heading */,
78 | .pl-mh .pl-en /* markup.heading entity.name */,
79 | .pl-ms /* meta.separator */ {
80 | color: #1d3e81;
81 | font-weight: bold;
82 | }
83 |
84 | .pl-mq /* markup.quote */ {
85 | color: #008080;
86 | }
87 |
88 | .pl-mi /* markup.italic */ {
89 | color: #333;
90 | font-style: italic;
91 | }
92 |
93 | .pl-mb /* markup.bold */ {
94 | color: #333;
95 | font-weight: bold;
96 | }
97 |
98 | .pl-md /* markup.deleted, meta.diff.header.from-file */ {
99 | background-color: #ffecec;
100 | color: #bd2c00;
101 | }
102 |
103 | .pl-mi1 /* markup.inserted, meta.diff.header.to-file */ {
104 | background-color: #eaffea;
105 | color: #55a532;
106 | }
107 |
108 | .pl-mdr /* meta.diff.range */ {
109 | color: #795da3;
110 | font-weight: bold;
111 | }
112 |
113 | .pl-mo /* meta.output */ {
114 | color: #1d3e81;
115 | }
116 |
117 |
--------------------------------------------------------------------------------
/docs/stylesheets/normalize.css:
--------------------------------------------------------------------------------
1 | /*! normalize.css v3.0.2 | MIT License | git.io/normalize */
2 |
3 | /**
4 | * 1. Set default font family to sans-serif.
5 | * 2. Prevent iOS text size adjust after orientation change, without disabling
6 | * user zoom.
7 | */
8 |
9 | html {
10 | font-family: sans-serif; /* 1 */
11 | -ms-text-size-adjust: 100%; /* 2 */
12 | -webkit-text-size-adjust: 100%; /* 2 */
13 | }
14 |
15 | /**
16 | * Remove default margin.
17 | */
18 |
19 | body {
20 | margin: 0;
21 | }
22 |
23 | /* HTML5 display definitions
24 | ========================================================================== */
25 |
26 | /**
27 | * Correct `block` display not defined for any HTML5 element in IE 8/9.
28 | * Correct `block` display not defined for `details` or `summary` in IE 10/11
29 | * and Firefox.
30 | * Correct `block` display not defined for `main` in IE 11.
31 | */
32 |
33 | article,
34 | aside,
35 | details,
36 | figcaption,
37 | figure,
38 | footer,
39 | header,
40 | hgroup,
41 | main,
42 | menu,
43 | nav,
44 | section,
45 | summary {
46 | display: block;
47 | }
48 |
49 | /**
50 | * 1. Correct `inline-block` display not defined in IE 8/9.
51 | * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera.
52 | */
53 |
54 | audio,
55 | canvas,
56 | progress,
57 | video {
58 | display: inline-block; /* 1 */
59 | vertical-align: baseline; /* 2 */
60 | }
61 |
62 | /**
63 | * Prevent modern browsers from displaying `audio` without controls.
64 | * Remove excess height in iOS 5 devices.
65 | */
66 |
67 | audio:not([controls]) {
68 | display: none;
69 | height: 0;
70 | }
71 |
72 | /**
73 | * Address `[hidden]` styling not present in IE 8/9/10.
74 | * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22.
75 | */
76 |
77 | [hidden],
78 | template {
79 | display: none;
80 | }
81 |
82 | /* Links
83 | ========================================================================== */
84 |
85 | /**
86 | * Remove the gray background color from active links in IE 10.
87 | */
88 |
89 | a {
90 | background-color: transparent;
91 | }
92 |
93 | /**
94 | * Improve readability when focused and also mouse hovered in all browsers.
95 | */
96 |
97 | a:active,
98 | a:hover {
99 | outline: 0;
100 | }
101 |
102 | /* Text-level semantics
103 | ========================================================================== */
104 |
105 | /**
106 | * Address styling not present in IE 8/9/10/11, Safari, and Chrome.
107 | */
108 |
109 | abbr[title] {
110 | border-bottom: 1px dotted;
111 | }
112 |
113 | /**
114 | * Address style set to `bolder` in Firefox 4+, Safari, and Chrome.
115 | */
116 |
117 | b,
118 | strong {
119 | font-weight: bold;
120 | }
121 |
122 | /**
123 | * Address styling not present in Safari and Chrome.
124 | */
125 |
126 | dfn {
127 | font-style: italic;
128 | }
129 |
130 | /**
131 | * Address variable `h1` font-size and margin within `section` and `article`
132 | * contexts in Firefox 4+, Safari, and Chrome.
133 | */
134 |
135 | h1 {
136 | font-size: 2em;
137 | margin: 0.67em 0;
138 | }
139 |
140 | /**
141 | * Address styling not present in IE 8/9.
142 | */
143 |
144 | mark {
145 | background: #ff0;
146 | color: #000;
147 | }
148 |
149 | /**
150 | * Address inconsistent and variable font size in all browsers.
151 | */
152 |
153 | small {
154 | font-size: 80%;
155 | }
156 |
157 | /**
158 | * Prevent `sub` and `sup` affecting `line-height` in all browsers.
159 | */
160 |
161 | sub,
162 | sup {
163 | font-size: 75%;
164 | line-height: 0;
165 | position: relative;
166 | vertical-align: baseline;
167 | }
168 |
169 | sup {
170 | top: -0.5em;
171 | }
172 |
173 | sub {
174 | bottom: -0.25em;
175 | }
176 |
177 | /* Embedded content
178 | ========================================================================== */
179 |
180 | /**
181 | * Remove border when inside `a` element in IE 8/9/10.
182 | */
183 |
184 | img {
185 | border: 0;
186 | }
187 |
188 | /**
189 | * Correct overflow not hidden in IE 9/10/11.
190 | */
191 |
192 | svg:not(:root) {
193 | overflow: hidden;
194 | }
195 |
196 | /* Grouping content
197 | ========================================================================== */
198 |
199 | /**
200 | * Address margin not present in IE 8/9 and Safari.
201 | */
202 |
203 | figure {
204 | margin: 1em 40px;
205 | }
206 |
207 | /**
208 | * Address differences between Firefox and other browsers.
209 | */
210 |
211 | hr {
212 | box-sizing: content-box;
213 | height: 0;
214 | }
215 |
216 | /**
217 | * Contain overflow in all browsers.
218 | */
219 |
220 | pre {
221 | overflow: auto;
222 | }
223 |
224 | /**
225 | * Address odd `em`-unit font size rendering in all browsers.
226 | */
227 |
228 | code,
229 | kbd,
230 | pre,
231 | samp {
232 | font-family: monospace, monospace;
233 | font-size: 1em;
234 | }
235 |
236 | /* Forms
237 | ========================================================================== */
238 |
239 | /**
240 | * Known limitation: by default, Chrome and Safari on OS X allow very limited
241 | * styling of `select`, unless a `border` property is set.
242 | */
243 |
244 | /**
245 | * 1. Correct color not being inherited.
246 | * Known issue: affects color of disabled elements.
247 | * 2. Correct font properties not being inherited.
248 | * 3. Address margins set differently in Firefox 4+, Safari, and Chrome.
249 | */
250 |
251 | button,
252 | input,
253 | optgroup,
254 | select,
255 | textarea {
256 | color: inherit; /* 1 */
257 | font: inherit; /* 2 */
258 | margin: 0; /* 3 */
259 | }
260 |
261 | /**
262 | * Address `overflow` set to `hidden` in IE 8/9/10/11.
263 | */
264 |
265 | button {
266 | overflow: visible;
267 | }
268 |
269 | /**
270 | * Address inconsistent `text-transform` inheritance for `button` and `select`.
271 | * All other form control elements do not inherit `text-transform` values.
272 | * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera.
273 | * Correct `select` style inheritance in Firefox.
274 | */
275 |
276 | button,
277 | select {
278 | text-transform: none;
279 | }
280 |
281 | /**
282 | * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
283 | * and `video` controls.
284 | * 2. Correct inability to style clickable `input` types in iOS.
285 | * 3. Improve usability and consistency of cursor style between image-type
286 | * `input` and others.
287 | */
288 |
289 | button,
290 | html input[type="button"], /* 1 */
291 | input[type="reset"],
292 | input[type="submit"] {
293 | -webkit-appearance: button; /* 2 */
294 | cursor: pointer; /* 3 */
295 | }
296 |
297 | /**
298 | * Re-set default cursor for disabled elements.
299 | */
300 |
301 | button[disabled],
302 | html input[disabled] {
303 | cursor: default;
304 | }
305 |
306 | /**
307 | * Remove inner padding and border in Firefox 4+.
308 | */
309 |
310 | button::-moz-focus-inner,
311 | input::-moz-focus-inner {
312 | border: 0;
313 | padding: 0;
314 | }
315 |
316 | /**
317 | * Address Firefox 4+ setting `line-height` on `input` using `!important` in
318 | * the UA stylesheet.
319 | */
320 |
321 | input {
322 | line-height: normal;
323 | }
324 |
325 | /**
326 | * It's recommended that you don't attempt to style these elements.
327 | * Firefox's implementation doesn't respect box-sizing, padding, or width.
328 | *
329 | * 1. Address box sizing set to `content-box` in IE 8/9/10.
330 | * 2. Remove excess padding in IE 8/9/10.
331 | */
332 |
333 | input[type="checkbox"],
334 | input[type="radio"] {
335 | box-sizing: border-box; /* 1 */
336 | padding: 0; /* 2 */
337 | }
338 |
339 | /**
340 | * Fix the cursor style for Chrome's increment/decrement buttons. For certain
341 | * `font-size` values of the `input`, it causes the cursor style of the
342 | * decrement button to change from `default` to `text`.
343 | */
344 |
345 | input[type="number"]::-webkit-inner-spin-button,
346 | input[type="number"]::-webkit-outer-spin-button {
347 | height: auto;
348 | }
349 |
350 | /**
351 | * 1. Address `appearance` set to `searchfield` in Safari and Chrome.
352 | * 2. Address `box-sizing` set to `border-box` in Safari and Chrome
353 | * (include `-moz` to future-proof).
354 | */
355 |
356 | input[type="search"] {
357 | -webkit-appearance: textfield; /* 1 */ /* 2 */
358 | box-sizing: content-box;
359 | }
360 |
361 | /**
362 | * Remove inner padding and search cancel button in Safari and Chrome on OS X.
363 | * Safari (but not Chrome) clips the cancel button when the search input has
364 | * padding (and `textfield` appearance).
365 | */
366 |
367 | input[type="search"]::-webkit-search-cancel-button,
368 | input[type="search"]::-webkit-search-decoration {
369 | -webkit-appearance: none;
370 | }
371 |
372 | /**
373 | * Define consistent border, margin, and padding.
374 | */
375 |
376 | fieldset {
377 | border: 1px solid #c0c0c0;
378 | margin: 0 2px;
379 | padding: 0.35em 0.625em 0.75em;
380 | }
381 |
382 | /**
383 | * 1. Correct `color` not being inherited in IE 8/9/10/11.
384 | * 2. Remove padding so people aren't caught out if they zero out fieldsets.
385 | */
386 |
387 | legend {
388 | border: 0; /* 1 */
389 | padding: 0; /* 2 */
390 | }
391 |
392 | /**
393 | * Remove default vertical scrollbar in IE 8/9/10/11.
394 | */
395 |
396 | textarea {
397 | overflow: auto;
398 | }
399 |
400 | /**
401 | * Don't inherit the `font-weight` (applied by a rule above).
402 | * NOTE: the default cannot safely be changed in Chrome and Safari on OS X.
403 | */
404 |
405 | optgroup {
406 | font-weight: bold;
407 | }
408 |
409 | /* Tables
410 | ========================================================================== */
411 |
412 | /**
413 | * Remove most spacing between table cells.
414 | */
415 |
416 | table {
417 | border-collapse: collapse;
418 | border-spacing: 0;
419 | }
420 |
421 | td,
422 | th {
423 | padding: 0;
424 | }
425 |
--------------------------------------------------------------------------------
/docs/stylesheets/stylesheet.css:
--------------------------------------------------------------------------------
1 | * {
2 | box-sizing: border-box; }
3 |
4 | body {
5 | padding: 0;
6 | margin: 0;
7 | font-family: "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
8 | font-size: 16px;
9 | line-height: 1.5;
10 | color: #606c71; }
11 |
12 | a {
13 | color: #1e6bb8;
14 | text-decoration: none; }
15 | a:hover {
16 | text-decoration: underline; }
17 |
18 | .btn {
19 | display: inline-block;
20 | margin-bottom: 1rem;
21 | color: rgba(255, 255, 255, 0.7);
22 | background-color: rgba(255, 255, 255, 0.08);
23 | border-color: rgba(255, 255, 255, 0.2);
24 | border-style: solid;
25 | border-width: 1px;
26 | border-radius: 0.3rem;
27 | transition: color 0.2s, background-color 0.2s, border-color 0.2s; }
28 | .btn + .btn {
29 | margin-left: 1rem; }
30 |
31 | .btn:hover {
32 | color: rgba(255, 255, 255, 0.8);
33 | text-decoration: none;
34 | background-color: rgba(255, 255, 255, 0.2);
35 | border-color: rgba(255, 255, 255, 0.3); }
36 |
37 | @media screen and (min-width: 64em) {
38 | .btn {
39 | padding: 0.75rem 1rem; } }
40 |
41 | @media screen and (min-width: 42em) and (max-width: 64em) {
42 | .btn {
43 | padding: 0.6rem 0.9rem;
44 | font-size: 0.9rem; } }
45 |
46 | @media screen and (max-width: 42em) {
47 | .btn {
48 | display: block;
49 | width: 100%;
50 | padding: 0.75rem;
51 | font-size: 0.9rem; }
52 | .btn + .btn {
53 | margin-top: 1rem;
54 | margin-left: 0; } }
55 |
56 | .page-header {
57 | color: #fff;
58 | text-align: center;
59 | background-color: #159957;
60 | background-image: linear-gradient(120deg, #155799, #159957); }
61 |
62 | @media screen and (min-width: 64em) {
63 | .page-header {
64 | padding: 5rem 6rem; } }
65 |
66 | @media screen and (min-width: 42em) and (max-width: 64em) {
67 | .page-header {
68 | padding: 3rem 4rem; } }
69 |
70 | @media screen and (max-width: 42em) {
71 | .page-header {
72 | padding: 2rem 1rem; } }
73 |
74 | .project-name {
75 | margin-top: 0;
76 | margin-bottom: 0.1rem; }
77 |
78 | @media screen and (min-width: 64em) {
79 | .project-name {
80 | font-size: 3.25rem; } }
81 |
82 | @media screen and (min-width: 42em) and (max-width: 64em) {
83 | .project-name {
84 | font-size: 2.25rem; } }
85 |
86 | @media screen and (max-width: 42em) {
87 | .project-name {
88 | font-size: 1.75rem; } }
89 |
90 | .project-tagline {
91 | margin-bottom: 2rem;
92 | font-weight: normal;
93 | opacity: 0.7; }
94 |
95 | @media screen and (min-width: 64em) {
96 | .project-tagline {
97 | font-size: 1.25rem; } }
98 |
99 | @media screen and (min-width: 42em) and (max-width: 64em) {
100 | .project-tagline {
101 | font-size: 1.15rem; } }
102 |
103 | @media screen and (max-width: 42em) {
104 | .project-tagline {
105 | font-size: 1rem; } }
106 |
107 | .main-content :first-child {
108 | margin-top: 0; }
109 | .main-content img {
110 | max-width: 100%; }
111 | .main-content h1, .main-content h2, .main-content h3, .main-content h4, .main-content h5, .main-content h6 {
112 | margin-top: 2rem;
113 | margin-bottom: 1rem;
114 | font-weight: normal;
115 | color: #159957; }
116 | .main-content p {
117 | margin-bottom: 1em; }
118 | .main-content code {
119 | padding: 2px 4px;
120 | font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
121 | font-size: 0.9rem;
122 | color: #383e41;
123 | background-color: #f3f6fa;
124 | border-radius: 0.3rem; }
125 | .main-content pre {
126 | padding: 0.8rem;
127 | margin-top: 0;
128 | margin-bottom: 1rem;
129 | font: 1rem Consolas, "Liberation Mono", Menlo, Courier, monospace;
130 | color: #567482;
131 | word-wrap: normal;
132 | background-color: #f3f6fa;
133 | border: solid 1px #dce6f0;
134 | border-radius: 0.3rem; }
135 | .main-content pre > code {
136 | padding: 0;
137 | margin: 0;
138 | font-size: 0.9rem;
139 | color: #567482;
140 | word-break: normal;
141 | white-space: pre;
142 | background: transparent;
143 | border: 0; }
144 | .main-content .highlight {
145 | margin-bottom: 1rem; }
146 | .main-content .highlight pre {
147 | margin-bottom: 0;
148 | word-break: normal; }
149 | .main-content .highlight pre, .main-content pre {
150 | padding: 0.8rem;
151 | overflow: auto;
152 | font-size: 0.9rem;
153 | line-height: 1.45;
154 | border-radius: 0.3rem; }
155 | .main-content pre code, .main-content pre tt {
156 | display: inline;
157 | max-width: initial;
158 | padding: 0;
159 | margin: 0;
160 | overflow: initial;
161 | line-height: inherit;
162 | word-wrap: normal;
163 | background-color: transparent;
164 | border: 0; }
165 | .main-content pre code:before, .main-content pre code:after, .main-content pre tt:before, .main-content pre tt:after {
166 | content: normal; }
167 | .main-content ul, .main-content ol {
168 | margin-top: 0; }
169 | .main-content blockquote {
170 | padding: 0 1rem;
171 | margin-left: 0;
172 | color: #819198;
173 | border-left: 0.3rem solid #dce6f0; }
174 | .main-content blockquote > :first-child {
175 | margin-top: 0; }
176 | .main-content blockquote > :last-child {
177 | margin-bottom: 0; }
178 | .main-content table {
179 | display: block;
180 | width: 100%;
181 | overflow: auto;
182 | word-break: normal;
183 | word-break: keep-all; }
184 | .main-content table th {
185 | font-weight: bold; }
186 | .main-content table th, .main-content table td {
187 | padding: 0.5rem 1rem;
188 | border: 1px solid #e9ebec; }
189 | .main-content dl {
190 | padding: 0; }
191 | .main-content dl dt {
192 | padding: 0;
193 | margin-top: 1rem;
194 | font-size: 1rem;
195 | font-weight: bold; }
196 | .main-content dl dd {
197 | padding: 0;
198 | margin-bottom: 1rem; }
199 | .main-content hr {
200 | height: 2px;
201 | padding: 0;
202 | margin: 1rem 0;
203 | background-color: #eff0f1;
204 | border: 0; }
205 |
206 | @media screen and (min-width: 64em) {
207 | .main-content {
208 | max-width: 64rem;
209 | padding: 2rem 6rem;
210 | margin: 0 auto;
211 | font-size: 1.1rem; } }
212 |
213 | @media screen and (min-width: 42em) and (max-width: 64em) {
214 | .main-content {
215 | padding: 2rem 4rem;
216 | font-size: 1.1rem; } }
217 |
218 | @media screen and (max-width: 42em) {
219 | .main-content {
220 | padding: 2rem 1rem;
221 | font-size: 1rem; } }
222 |
223 | .site-footer {
224 | padding-top: 2rem;
225 | margin-top: 2rem;
226 | border-top: solid 1px #eff0f1; }
227 |
228 | .site-footer-owner {
229 | display: block;
230 | font-weight: bold; }
231 |
232 | .site-footer-credits {
233 | color: #819198; }
234 |
235 | @media screen and (min-width: 64em) {
236 | .site-footer {
237 | font-size: 1rem; } }
238 |
239 | @media screen and (min-width: 42em) and (max-width: 64em) {
240 | .site-footer {
241 | font-size: 1rem; } }
242 |
243 | @media screen and (max-width: 42em) {
244 | .site-footer {
245 | font-size: 0.9rem; } }
246 |
--------------------------------------------------------------------------------
/index.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * This allows for imports from @ngageoint/mgrs-js
3 | * @since 1.0.0
4 | */
5 | export * from './lib/MGRS';
6 | export * from './lib/MGRSConstants';
7 | export * from './lib/MGRSUtils';
8 |
9 | export * from './lib/features/GridLine';
10 |
11 | export * from './lib/grid/Grid';
12 | export * from './lib/grid/GridLabel';
13 | export * from './lib/grid/GridLabeler';
14 | export * from './lib/grid/GridType';
15 | export * from './lib/grid/GridTypeUtils';
16 | export * from './lib/grid/Grids';
17 | export * from './lib/grid/MGRSLabeler';
18 | export * from './lib/grid/ZoomGrids';
19 |
20 | export * from './lib/gzd/BandLetterRange';
21 | export * from './lib/gzd/GZDLabeler';
22 | export * from './lib/gzd/GridRange';
23 | export * from './lib/gzd/GridZone';
24 | export * from './lib/gzd/GridZones';
25 | export * from './lib/gzd/LatitudeBand';
26 | export * from './lib/gzd/LongitudinalStrip';
27 | export * from './lib/gzd/ZoneNumberRange';
28 |
29 | export * from './lib/property/MGRSProperties';
30 |
31 | export * from './lib/utm/UTM';
--------------------------------------------------------------------------------
/lib/MGRS.ts:
--------------------------------------------------------------------------------
1 | import { Hemisphere, Line, Point } from '@ngageoint/grid-js';
2 | import { GridType } from './grid/GridType';
3 | import * as sprintf from 'sprintf-js';
4 | import { GridTypeUtils } from './grid/GridTypeUtils';
5 | import { GridZone } from './gzd/GridZone';
6 | import { UTM } from './utm/UTM';
7 | import { GridZones } from './gzd/GridZones';
8 | import { MGRSUtils } from './MGRSUtils';
9 |
10 | /**
11 | * Military Grid Reference System Coordinate
12 | */
13 | export class MGRS {
14 | /**
15 | * 100km grid square column (‘e’) letters repeat every third zone
16 | */
17 | private static readonly columnLetters = ['ABCDEFGH', 'JKLMNPQR', 'STUVWXYZ'];
18 |
19 | /**
20 | * 100km grid square row (‘n’) letters repeat every other zone
21 | */
22 | private static readonly rowLetters = ['ABCDEFGHJKLMNPQRSTUV', 'FGHJKLMNPQRSTUVABCDE'];
23 |
24 | /**
25 | * MGRS string pattern
26 | */
27 | private static readonly mgrsPattern = new RegExp(
28 | '^(\\d{1,2})([C-HJ-NP-X])(?:([A-HJ-NP-Z][A-HJ-NP-V])((\\d{2}){0,5}))?$',
29 | 'i',
30 | );
31 |
32 | /**
33 | * MGRS invalid string pattern (Svalbard)
34 | */
35 | private static readonly mgrsInvalidPattern = new RegExp('^3[246]X.*$', 'i');
36 |
37 | /**
38 | * Zone number
39 | */
40 | private readonly zone: number;
41 |
42 | /**
43 | * Band letter
44 | */
45 | private readonly band: string;
46 |
47 | /**
48 | * Column letter
49 | */
50 | private readonly column: string;
51 |
52 | /**
53 | * Row letter
54 | */
55 | private readonly row: string;
56 |
57 | /**
58 | * Easting
59 | */
60 | private readonly easting: number;
61 |
62 | /**
63 | * Northing
64 | */
65 | private readonly northing: number;
66 |
67 | /**
68 | * Create
69 | *
70 | * @param zone
71 | * zone number
72 | * @param band
73 | * band letter
74 | * @param easting
75 | * easting
76 | * @param northing
77 | * northing
78 | * @return MGRS
79 | */
80 | public static create(
81 | zone: number,
82 | band: string,
83 | easting: number,
84 | northing: number,
85 | column?: string,
86 | row?: string,
87 | ): MGRS {
88 | if (!column) {
89 | column = this.getColumnLetter(zone, easting);
90 | }
91 | if (!row) {
92 | row = this.getRowLetter(zone, northing);
93 | }
94 |
95 | return new MGRS(zone, band, column, row, easting, northing);
96 | }
97 |
98 | /**
99 | * Constructor
100 | *
101 | * @param zone
102 | * zone number
103 | * @param band
104 | * band letter
105 | * @param column
106 | * column letter
107 | * @param row
108 | * row letter
109 | * @param easting
110 | * easting
111 | * @param northing
112 | * northing
113 | */
114 | constructor(zone: number, band: string, column: string, row: string, easting: number, northing: number) {
115 | this.zone = zone;
116 | this.band = band;
117 | this.column = column;
118 | this.row = row;
119 | this.easting = easting;
120 | this.northing = northing;
121 | }
122 |
123 | /**
124 | * Get the zone number
125 | *
126 | * @return zone number
127 | */
128 | public getZone(): number {
129 | return this.zone;
130 | }
131 |
132 | /**
133 | * Get the band letter
134 | *
135 | * @return band letter
136 | */
137 | public getBand(): string {
138 | return this.band;
139 | }
140 |
141 | /**
142 | * Get the column letter
143 | *
144 | * @return column letter
145 | */
146 | public getColumn(): string {
147 | return this.column;
148 | }
149 |
150 | /**
151 | * Get the row letter
152 | *
153 | * @return row letter
154 | */
155 | public getRow(): string {
156 | return this.row;
157 | }
158 |
159 | /**
160 | * Get the easting
161 | *
162 | * @return easting
163 | */
164 | public getEasting(): number {
165 | return this.easting;
166 | }
167 |
168 | /**
169 | * Get the northing
170 | *
171 | * @return northing
172 | */
173 | public getNorthing(): number {
174 | return this.northing;
175 | }
176 |
177 | /**
178 | * Get the hemisphere
179 | *
180 | * @return hemisphere
181 | */
182 | public getHemisphere(): Hemisphere {
183 | return MGRSUtils.getHemisphere(this.band);
184 | }
185 |
186 | /**
187 | * Get the MGRS coordinate with specified grid precision
188 | *
189 | * @param type
190 | * grid type precision
191 | * @return MGRS coordinate
192 | */
193 | public coordinate(type?: GridType): string {
194 | let mgrs = '';
195 |
196 | if (type === null || type === undefined) {
197 | type = GridType.METER;
198 | }
199 |
200 | mgrs += this.zone;
201 | mgrs += this.band;
202 |
203 | if (type.valueOf() !== GridType.GZD.valueOf()) {
204 | mgrs += this.column;
205 | mgrs += this.row;
206 |
207 | if (type !== GridType.HUNDRED_KILOMETER) {
208 | mgrs += this.getEastingAndNorthing(type);
209 | }
210 | }
211 |
212 | return mgrs.toString();
213 | }
214 |
215 | /**
216 | * Get the easting and northing concatenated value in the grid type
217 | * precision
218 | *
219 | * @param type
220 | * grid type precision
221 | * @return easting and northing value
222 | */
223 | public getEastingAndNorthing(type: GridType): string {
224 | const accuracy = 5 - ~~Math.log10(type);
225 |
226 | // TODO apply locale
227 | const easting = sprintf.sprintf('%05d', this.easting);
228 | const northing = sprintf.sprintf('%05d', this.northing);
229 |
230 | return easting.substring(0, accuracy) + northing.substring(0, accuracy);
231 | }
232 |
233 | /**
234 | * Get the MGRS coordinate with the accuracy number of digits in the easting
235 | * and northing values. Accuracy must be inclusively between 0
236 | * ({@link GridType#HUNDRED_KILOMETER}) and 5 ({@link GridType#METER}).
237 | *
238 | * @param accuracy
239 | * accuracy digits between 0 (inclusive) and 5 (inclusive)
240 | * @return MGRS coordinate
241 | */
242 | public coordinateFromAccuracy(accuracy: number): string {
243 | return this.coordinate(GridTypeUtils.withAccuracy(accuracy));
244 | }
245 |
246 | /**
247 | * Get the MGRS coordinate grid precision
248 | *
249 | * @return grid type precision
250 | */
251 | public precision(): GridType {
252 | return GridTypeUtils.withAccuracy(this.accuracy());
253 | }
254 |
255 | /**
256 | * Get the MGRS coordinate accuracy number of digits
257 | *
258 | * @return accuracy digits
259 | */
260 | public accuracy(): number {
261 | let accuracy = 5;
262 |
263 | for (let accuracyLevel = 10; accuracyLevel <= 100000; accuracyLevel *= 10) {
264 | if (this.easting % accuracyLevel !== 0 || this.northing % accuracyLevel !== 0) {
265 | break;
266 | }
267 | accuracy--;
268 | }
269 |
270 | return accuracy;
271 | }
272 |
273 | /**
274 | * Get the two letter column and row 100k designator
275 | *
276 | * @return the two letter column and row 100k designator
277 | */
278 | public getColumnRowId(): string {
279 | return this.column + this.row;
280 | }
281 |
282 | /**
283 | * Get the GZD grid zone
284 | *
285 | * @return GZD grid zone
286 | */
287 | public getGridZone(): GridZone {
288 | return GridZones.getGridZoneFromMGRS(this);
289 | }
290 |
291 | /**
292 | * Convert to a point
293 | *
294 | * @return point
295 | */
296 | public toPoint(): Point {
297 | return this.toUTM().toPoint();
298 | }
299 |
300 | /**
301 | * Convert to UTM coordinate
302 | *
303 | * @return UTM
304 | */
305 | public toUTM(): UTM {
306 | const easting = this.getUTMEasting();
307 | const northing = this.getUTMNorthing();
308 | const hemisphere = this.getHemisphere();
309 |
310 | return UTM.create(this.zone, hemisphere, easting, northing);
311 | }
312 |
313 | /**
314 | * Get the UTM easting
315 | *
316 | * @return UTM easting
317 | */
318 | public getUTMEasting(): number {
319 | // get easting specified by e100k
320 | const columnLetters = MGRS.getColumnLetters(this.zone);
321 | const columnIndex = columnLetters.indexOf(this.column) + 1;
322 | // index+1 since A (index 0) -> 1*100e3, B (index 1) -> 2*100e3, etc.
323 | const e100kNum = columnIndex * 100000.0; // e100k in meters
324 |
325 | return e100kNum + this.easting;
326 | }
327 |
328 | /**
329 | * Get the UTM northing
330 | *
331 | * @return UTM northing
332 | */
333 | public getUTMNorthing(): number {
334 | // get northing specified by n100k
335 | const rowLetters = MGRS.getRowLetters(this.zone);
336 | const rowIndex = rowLetters.indexOf(this.row);
337 | const n100kNum = rowIndex * 100000.0; // n100k in meters
338 |
339 | // get latitude of (bottom of) band
340 | const latBand = GridZones.getSouthLatitude(this.band);
341 |
342 | // northing of bottom of band, extended to include entirety of
343 | // bottommost 100km square
344 | // (100km square boundaries are aligned with 100km UTM northing
345 | // intervals)
346 |
347 | const latBandNorthing = UTM.from(Point.degrees(0, latBand)).getNorthing();
348 | const nBand = Math.floor(latBandNorthing / 100000) * 100000;
349 |
350 | // 100km grid square row letters repeat every 2,000km north; add enough
351 | // 2,000km blocks to get
352 | // into required band
353 | let n2M = 0; // northing of 2,000km block
354 | while (n2M + n100kNum + this.northing < nBand) {
355 | n2M += 2000000;
356 | }
357 |
358 | return n2M + n100kNum + this.northing;
359 | }
360 |
361 | /**
362 | * {@inheritDoc}
363 | */
364 | public toString(): string {
365 | return this.coordinate(GridType.METER);
366 | }
367 |
368 | /**
369 | * Return whether the given string is valid MGRS string
370 | *
371 | * @param mgrs
372 | * potential MGRS string
373 | * @return true if MGRS string is valid, false otherwise
374 | */
375 | public static isMGRS(mgrs: string): boolean {
376 | mgrs = MGRS.removeSpaces(mgrs);
377 | return MGRS.mgrsPattern.test(mgrs) && !MGRS.mgrsInvalidPattern.test(mgrs);
378 | }
379 |
380 | /**
381 | * Removed spaces from the value
382 | *
383 | * @param value
384 | * value string
385 | * @return value without spaces
386 | */
387 | private static removeSpaces(value: string): string {
388 | return value.replace(/\s/g, '');
389 | }
390 |
391 | /**
392 | * Encodes a point as a MGRS string
393 | *
394 | * @param point
395 | * point
396 | * @return MGRS
397 | */
398 | public static from(point: Point): MGRS {
399 | point = point.toDegrees();
400 |
401 | const utm = UTM.from(point);
402 |
403 | const bandLetter = GridZones.getBandLetterFromLatitude(point.getLatitude());
404 |
405 | const columnLetter = MGRS.getColumnLetterFromUTM(utm);
406 |
407 | const rowLetter = MGRS.getRowLetterFromUTM(utm);
408 |
409 | // truncate easting/northing to within 100km grid square
410 | const easting = ~~(utm.getEasting() % 100000);
411 | const northing = ~~(utm.getNorthing() % 100000);
412 |
413 | return MGRS.create(utm.getZone(), bandLetter, easting, northing, columnLetter, rowLetter);
414 | }
415 |
416 | /**
417 | * Parse a MGRS string
418 | *
419 | * @param mgrs
420 | * MGRS string
421 | * @return MGRS
422 | * @throws ParseException
423 | * upon failure to parse the MGRS string
424 | */
425 | public static parse(mgrs: string): MGRS {
426 | if (!MGRS.mgrsPattern.test(MGRS.removeSpaces(mgrs))) {
427 | throw new Error('Invalid MGRS: ' + mgrs);
428 | }
429 |
430 | const matches = MGRS.removeSpaces(mgrs).match(MGRS.mgrsPattern);
431 |
432 | const zone = Number.parseInt(matches![1], 10);
433 | const band = matches![2].toUpperCase().charAt(0);
434 |
435 | const gridZone = GridZones.getGridZone(zone, band);
436 | if (gridZone == null) {
437 | throw new Error('Invalid MGRS: ' + mgrs);
438 | }
439 |
440 | let mgrsValue: MGRS | undefined;
441 |
442 | let columnRow = matches![3];
443 | if (columnRow) {
444 | columnRow = columnRow.toUpperCase();
445 | const column = columnRow.charAt(0);
446 | const row = columnRow.charAt(1);
447 |
448 | // parse easting & northing
449 | let easting = 0;
450 | let northing = 0;
451 | const location = matches![4];
452 | if (location.length > 0) {
453 | const precision = location.length / 2;
454 | const multiplier = Math.pow(10.0, 5 - precision);
455 | easting = +location.substring(0, precision) * multiplier;
456 | northing = +location.substring(precision) * multiplier;
457 | }
458 |
459 | mgrsValue = MGRS.create(zone, band, easting, northing, column, row);
460 |
461 | if (location.length === 0) {
462 | const point = mgrsValue.toPoint().toDegrees();
463 | const gridBounds = gridZone.getBounds();
464 | const gridSouthwest = gridBounds.getSouthwest().toDegrees();
465 |
466 | const westBounds = point.getLongitude() < gridSouthwest.getLongitude();
467 | const southBounds = point.getLatitude() < gridSouthwest.getLatitude();
468 |
469 | if (westBounds || southBounds) {
470 | if (westBounds && southBounds) {
471 | const northeast = MGRS.create(
472 | zone,
473 | band,
474 | GridType.HUNDRED_KILOMETER,
475 | GridType.HUNDRED_KILOMETER,
476 | column,
477 | row,
478 | ).toPoint();
479 | if (gridBounds.containsPoint(northeast)) {
480 | mgrsValue = MGRS.from(Point.degrees(gridSouthwest.getLongitude(), gridSouthwest.getLatitude()));
481 | }
482 | } else if (westBounds) {
483 | const east = MGRS.create(zone, band, GridType.HUNDRED_KILOMETER, northing, column, row).toPoint();
484 | if (gridBounds.containsPoint(east)) {
485 | const intersection = MGRS.getWesternBoundsPoint(gridZone, point, east);
486 | mgrsValue = MGRS.from(intersection);
487 | }
488 | } else if (southBounds) {
489 | const north = MGRS.create(zone, band, easting, GridType.HUNDRED_KILOMETER, column, row).toPoint();
490 | if (gridBounds.containsPoint(north)) {
491 | const intersection = MGRS.getSouthernBoundsPoint(gridZone, point, north);
492 | mgrsValue = MGRS.from(intersection);
493 | }
494 | }
495 | }
496 | }
497 | } else {
498 | mgrsValue = MGRS.from(gridZone.getBounds().getSouthwest());
499 | }
500 |
501 | return mgrsValue;
502 | }
503 |
504 | /**
505 | * Get the point on the western grid zone bounds point between the western
506 | * and eastern points
507 | *
508 | * @param gridZone
509 | * grid zone
510 | * @param west
511 | * western point
512 | * @param east
513 | * eastern point
514 | * @return western grid bounds point
515 | */
516 | private static getWesternBoundsPoint(gridZone: GridZone, west: Point, east: Point): Point {
517 | const eastUTM = UTM.from(east);
518 | const northing = eastUTM.getNorthing();
519 |
520 | const zoneNumber = gridZone.getNumber();
521 | const hemisphere = gridZone.getHemisphere();
522 |
523 | const line = Line.line(west, east);
524 | const boundsLine = gridZone.getBounds().getWestLine();
525 |
526 | const intersection = line.intersection(boundsLine);
527 |
528 | // Intersection easting
529 | const intersectionUTM = UTM.from(intersection!, zoneNumber, hemisphere);
530 | const intersectionEasting = intersectionUTM.getEasting();
531 |
532 | // One meter precision just inside the bounds
533 | const boundsEasting = Math.ceil(intersectionEasting);
534 |
535 | // Higher precision point just inside of the bounds
536 | const boundsPoint = UTM.point(zoneNumber, hemisphere, boundsEasting, northing);
537 |
538 | boundsPoint.setLongitude(boundsLine.getPoint1().getLongitude());
539 |
540 | return boundsPoint;
541 | }
542 |
543 | /**
544 | * Get the point on the southern grid zone bounds point between the southern
545 | * and northern points
546 | *
547 | * @param gridZone
548 | * grid zone
549 | * @param south
550 | * southern point
551 | * @param north
552 | * northern point
553 | * @return southern grid bounds point
554 | */
555 | private static getSouthernBoundsPoint(gridZone: GridZone, south: Point, north: Point): Point {
556 | const northUTM = UTM.from(north);
557 | const easting = northUTM.getEasting();
558 |
559 | const zoneNumber = gridZone.getNumber();
560 | const hemisphere = gridZone.getHemisphere();
561 |
562 | const line = Line.line(south, north);
563 | const boundsLine = gridZone.getBounds().getSouthLine();
564 |
565 | const intersection = line.intersection(boundsLine);
566 |
567 | // Intersection northing
568 | const intersectionUTM = UTM.from(intersection!, zoneNumber, hemisphere);
569 | const intersectionNorthing = intersectionUTM.getNorthing();
570 |
571 | // One meter precision just inside the bounds
572 | const boundsNorthing = Math.ceil(intersectionNorthing);
573 |
574 | // Higher precision point just inside of the bounds
575 | const boundsPoint = UTM.point(zoneNumber, hemisphere, easting, boundsNorthing);
576 |
577 | boundsPoint.setLatitude(boundsLine.getPoint1().getLatitude());
578 |
579 | return boundsPoint;
580 | }
581 |
582 | /**
583 | * Parse the MGRS string for the precision
584 | *
585 | * @param mgrs
586 | * MGRS string
587 | * @return grid type precision
588 | * @throws ParseException
589 | * upon failure to parse the MGRS string
590 | */
591 | public static precision(mgrs: string): GridType {
592 | if (!MGRS.mgrsPattern.test(MGRS.removeSpaces(mgrs))) {
593 | throw new Error('Invalid MGRS: ' + mgrs);
594 | }
595 |
596 | const matches = MGRS.removeSpaces(mgrs).match(MGRS.mgrsPattern);
597 |
598 | let precision: GridType | undefined;
599 |
600 | if (matches![3]) {
601 | const location = matches![4];
602 | if (location.length > 0) {
603 | precision = GridTypeUtils.withAccuracy(location.length / 2);
604 | } else {
605 | precision = GridType.HUNDRED_KILOMETER;
606 | }
607 | } else {
608 | precision = GridType.GZD;
609 | }
610 |
611 | return precision;
612 | }
613 |
614 | /**
615 | * Get the MGRS coordinate accuracy number of digits
616 | *
617 | * @param mgrs
618 | * MGRS string
619 | * @return accuracy digits
620 | * @throws ParseException
621 | * upon failure to parse the MGRS string
622 | */
623 | public static accuracy(mgrs: string): number {
624 | return GridTypeUtils.getAccuracy(MGRS.precision(mgrs));
625 | }
626 |
627 | /**
628 | * Get the two letter column and row 100k designator for a given UTM
629 | * easting, northing and zone number value
630 | *
631 | * @param easting
632 | * easting
633 | * @param northing
634 | * northing
635 | * @param zoneNumber
636 | * zone number
637 | * @return the two letter column and row 100k designator
638 | */
639 | public static getColumnRowId(easting: number, northing: number, zoneNumber: number): string {
640 | const columnLetter = MGRS.getColumnLetter(zoneNumber, easting);
641 |
642 | const rowLetter = MGRS.getRowLetter(zoneNumber, northing);
643 |
644 | return columnLetter + rowLetter;
645 | }
646 |
647 | /**
648 | * Get the column letter from the UTM
649 | *
650 | * @param utm
651 | * UTM
652 | * @return column letter
653 | */
654 | public static getColumnLetterFromUTM(utm: UTM): string {
655 | return MGRS.getColumnLetter(utm.getZone(), utm.getEasting());
656 | }
657 |
658 | /**
659 | * Get the column letter from the zone number and easting
660 | *
661 | * @param zoneNumber
662 | * zone number
663 | * @param easting
664 | * easting
665 | * @return column letter
666 | */
667 | public static getColumnLetter(zoneNumber: number, easting: number): string {
668 | // columns in zone 1 are A-H, zone 2 J-R, zone 3 S-Z, then repeating
669 | // every 3rd zone
670 | const column = ~~Math.floor(easting / 100000);
671 | const columnLetters = MGRS.getColumnLetters(zoneNumber);
672 | return columnLetters.charAt(column - 1);
673 | }
674 |
675 | /**
676 | * Get the row letter from the UTM
677 | *
678 | * @param utm
679 | * UTM
680 | * @return row letter
681 | */
682 | public static getRowLetterFromUTM(utm: UTM): string {
683 | return MGRS.getRowLetter(utm.getZone(), utm.getNorthing());
684 | }
685 |
686 | /**
687 | * Get the row letter from the zone number and northing
688 | *
689 | * @param zoneNumber
690 | * zone number
691 | * @param northing
692 | * northing
693 | * @return row letter
694 | */
695 | public static getRowLetter(zoneNumber: number, northing: number): string {
696 | // rows in even zones are A-V, in odd zones are F-E
697 | const row = ~~Math.floor(northing / 100000) % 20;
698 | const rowLetters = MGRS.getRowLetters(zoneNumber);
699 | return rowLetters.charAt(row);
700 | }
701 |
702 | /**
703 | * Get the column letters for the zone number
704 | *
705 | * @param zoneNumber
706 | * zone number
707 | * @return column letters
708 | */
709 | private static getColumnLetters(zoneNumber: number): string {
710 | return MGRS.columnLetters[(zoneNumber - 1) % 3];
711 | }
712 |
713 | /**
714 | * Get the row letters for the zone number
715 | *
716 | * @param zoneNumber
717 | * zone number
718 | * @return row letters
719 | */
720 | private static getRowLetters(zoneNumber: number): string {
721 | return MGRS.rowLetters[(zoneNumber - 1) % 2];
722 | }
723 | }
724 |
--------------------------------------------------------------------------------
/lib/MGRSConstants.ts:
--------------------------------------------------------------------------------
1 | import { GridConstants } from '@ngageoint/grid-js';
2 |
3 | /**
4 | * Military Grid Reference System Constants
5 | */
6 | export class MGRSConstants {
7 | /**
8 | * Minimum longitude
9 | */
10 | public static readonly MIN_LON = GridConstants.MIN_LON;
11 |
12 | /**
13 | * Maximum longitude
14 | */
15 | public static readonly MAX_LON = GridConstants.MAX_LON;
16 |
17 | /**
18 | * Minimum latitude
19 | */
20 | public static readonly MIN_LAT = -80.0;
21 |
22 | /**
23 | * Maximum latitude
24 | */
25 | public static readonly MAX_LAT = 84.0;
26 |
27 | /**
28 | * Minimum grid zone number
29 | */
30 | public static readonly MIN_ZONE_NUMBER = 1;
31 |
32 | /**
33 | * Maximum grid zone number
34 | */
35 | public static readonly MAX_ZONE_NUMBER = 60;
36 |
37 | /**
38 | * Grid zone width
39 | */
40 | public static readonly ZONE_WIDTH = 6.0;
41 |
42 | /**
43 | * Minimum grid band letter
44 | */
45 | public static readonly MIN_BAND_LETTER = 'C';
46 |
47 | /**
48 | * Maximum grid band letter
49 | */
50 | public static readonly MAX_BAND_LETTER = 'X';
51 |
52 | /**
53 | * Number of bands
54 | */
55 | public static readonly NUM_BANDS = 20;
56 |
57 | /**
58 | * Grid band height for all by but the {@link #MAX_BAND_LETTER}
59 | */
60 | public static readonly BAND_HEIGHT = 8.0;
61 |
62 | /**
63 | * Grid band height for the {@link #MAX_BAND_LETTER}
64 | */
65 | public static readonly MAX_BAND_HEIGHT = 12.0;
66 |
67 | /**
68 | * Last southern hemisphere band letter
69 | */
70 | public static readonly BAND_LETTER_SOUTH = 'M';
71 |
72 | /**
73 | * First northern hemisphere band letter
74 | */
75 | public static readonly BAND_LETTER_NORTH = 'N';
76 |
77 | /**
78 | * Min zone number in Svalbard grid zones
79 | */
80 | public static readonly MIN_SVALBARD_ZONE_NUMBER = 31;
81 |
82 | /**
83 | * Max zone number in Svalbard grid zones
84 | */
85 | public static readonly MAX_SVALBARD_ZONE_NUMBER = 37;
86 |
87 | /**
88 | * Band letter in Svalbard grid zones
89 | */
90 | public static readonly SVALBARD_BAND_LETTER = MGRSConstants.MAX_BAND_LETTER;
91 |
92 | /**
93 | * Min zone number in Norway grid zones
94 | */
95 | public static readonly MIN_NORWAY_ZONE_NUMBER = 31;
96 |
97 | /**
98 | * Max zone number in Norway grid zones
99 | */
100 | public static readonly MAX_NORWAY_ZONE_NUMBER = 32;
101 |
102 | /**
103 | * Band letter in Norway grid zones
104 | */
105 | public static readonly NORWAY_BAND_LETTER = 'V';
106 | }
107 |
--------------------------------------------------------------------------------
/lib/MGRSUtils.ts:
--------------------------------------------------------------------------------
1 | import { GridUtils, Hemisphere } from '@ngageoint/grid-js';
2 | import { MGRSConstants } from './MGRSConstants';
3 |
4 | /**
5 | * Military Grid Reference System utilities
6 | */
7 | export class MGRSUtils {
8 | /**
9 | * Validate the zone number
10 | *
11 | * @param zoneNumber
12 | * zone number
13 | */
14 | public static validateZoneNumber(zoneNumber: number): void {
15 | if (zoneNumber < MGRSConstants.MIN_ZONE_NUMBER || zoneNumber > MGRSConstants.MAX_ZONE_NUMBER) {
16 | throw new Error(
17 | 'Illegal zone number (expected ' +
18 | MGRSConstants.MIN_ZONE_NUMBER +
19 | ' - ' +
20 | MGRSConstants.MAX_ZONE_NUMBER +
21 | '): ' +
22 | zoneNumber,
23 | );
24 | }
25 | }
26 |
27 | /**
28 | * Validate the band letter
29 | *
30 | * @param letter
31 | * band letter
32 | */
33 | public static validateBandLetter(letter: string): void {
34 | if (
35 | letter.charCodeAt(0) < MGRSConstants.MIN_BAND_LETTER.charCodeAt(0) ||
36 | letter.charCodeAt(0) > MGRSConstants.MAX_BAND_LETTER.charCodeAt(0) ||
37 | GridUtils.isOmittedBandLetter(letter)
38 | ) {
39 | throw new Error('Illegal band letter (CDEFGHJKLMNPQRSTUVWX): ' + letter);
40 | }
41 | }
42 |
43 | /**
44 | * Get the next band letter
45 | *
46 | * @param letter
47 | * band letter
48 | * @return next band letter, 'Y' ({@link MGRSConstants#MAX_BAND_LETTER} + 1)
49 | * if no next bands
50 | */
51 | public static nextBandLetter(letter: string): string {
52 | MGRSUtils.validateBandLetter(letter);
53 |
54 | let charLetter = letter.charCodeAt(0);
55 |
56 | charLetter++;
57 | if (GridUtils.isOmittedBandLetter(String.fromCharCode(charLetter))) {
58 | charLetter++;
59 | }
60 | return String.fromCharCode(charLetter);
61 | }
62 |
63 | /**
64 | * Get the previous band letter
65 | *
66 | * @param letter
67 | * band letter
68 | * @return previous band letter, 'B' ({@link MGRSConstants#MIN_BAND_LETTER}
69 | * - 1) if no previous bands
70 | */
71 | public static previousBandLetter(letter: string): string {
72 | MGRSUtils.validateBandLetter(letter);
73 |
74 | let charLetter = letter.charCodeAt(0);
75 | charLetter--;
76 | if (GridUtils.isOmittedBandLetter(String.fromCharCode(charLetter))) {
77 | charLetter--;
78 | }
79 | return String.fromCharCode(charLetter);
80 | }
81 |
82 | /**
83 | * Get the label name
84 | *
85 | * @param zoneNumber
86 | * zone number
87 | * @param bandLetter
88 | * band letter
89 | * @return name
90 | */
91 | public static getLabelName(zoneNumber: number, bandLetter: string): string {
92 | return zoneNumber + bandLetter;
93 | }
94 |
95 | /**
96 | * Get the hemisphere from the band letter
97 | *
98 | * @param bandLetter
99 | * band letter
100 | * @return hemisphere
101 | */
102 | public static getHemisphere(bandLetter: string): Hemisphere {
103 | return bandLetter < MGRSConstants.BAND_LETTER_NORTH ? Hemisphere.SOUTH : Hemisphere.NORTH;
104 | }
105 | }
106 |
--------------------------------------------------------------------------------
/lib/features/GridLine.ts:
--------------------------------------------------------------------------------
1 | import { Line, Point } from '@ngageoint/grid-js';
2 | import { GridType } from '../grid/GridType';
3 |
4 | /**
5 | * Line between two points
6 | */
7 | export class GridLine extends Line {
8 | /**
9 | * Grid type the line represents if any
10 | */
11 | private gridType?: GridType;
12 |
13 | /**
14 | * Create a line
15 | *
16 | * @param point1
17 | * first point
18 | * @param point2
19 | * second point
20 | * @param gridType
21 | * line grid type (optional)
22 | * @return line
23 | */
24 | public static lineFromPoints(point1: Point, point2: Point, gridType?: GridType): GridLine {
25 | const gridLine = new GridLine(Line.line(point1, point2));
26 | gridLine.gridType = gridType;
27 | return gridLine;
28 | }
29 |
30 | /**
31 | * Create a line
32 | *
33 | * @param line
34 | * line to copy
35 | * @param gridType
36 | * line grid type (optional)
37 | * @return line
38 | */
39 | public static lineFromLine(line: Line, gridType?: GridType): GridLine {
40 | const gridLine = new GridLine(line);
41 | gridLine.gridType = gridType;
42 | return gridLine;
43 | }
44 |
45 | /**
46 | * Copy a line
47 | *
48 | * @param line
49 | * line to copy
50 | * @return line
51 | */
52 | public static lineFromGridLine(line: GridLine): GridLine {
53 | return GridLine.lineFromLine(line, line.gridType);
54 | }
55 |
56 | /**
57 | * Constructor
58 | *
59 | * @param line
60 | * line to copy
61 | */
62 | constructor(line: Line) {
63 | super(line);
64 | }
65 |
66 | /**
67 | * Get the line grid type
68 | *
69 | * @return grid type
70 | */
71 | public getGridType(): GridType | undefined {
72 | return this.gridType;
73 | }
74 |
75 | /**
76 | * Check if the line has a grid type
77 | *
78 | * @return true if has grid type
79 | */
80 | public hasGridType(): boolean {
81 | if (this.gridType) {
82 | return true;
83 | }
84 | return false;
85 | }
86 |
87 | /**
88 | * Set the line grid type
89 | *
90 | * @param gridType
91 | * grid type
92 | */
93 | public setGridType(gridType: GridType): void {
94 | this.gridType = gridType;
95 | }
96 |
97 | /**
98 | * Copy the line
99 | *
100 | * @return line copy
101 | */
102 | public copy(): GridLine {
103 | return GridLine.lineFromGridLine(this);
104 | }
105 |
106 | /**
107 | * {@inheritDoc}
108 | */
109 | public equals(obj: any): boolean {
110 | if (this === obj) return true;
111 | if (!super.equals(obj)) return false;
112 | if (typeof this !== typeof obj) return false;
113 | const other = obj as GridLine;
114 | if (this.gridType !== other.gridType) return false;
115 | return true;
116 | }
117 | }
118 |
--------------------------------------------------------------------------------
/lib/grid/Grid.ts:
--------------------------------------------------------------------------------
1 | import { Color } from '@ngageoint/color-js';
2 | import { BaseGrid, Bounds, GridStyle, GridTile, PropertyConstants } from '@ngageoint/grid-js';
3 | import { IComparable } from 'tstl';
4 | import { GridLine } from '../features/GridLine';
5 | import { GridZone } from '../gzd/GridZone';
6 | import { MGRSProperties } from '../property/MGRSProperties';
7 | import { GridLabel } from './GridLabel';
8 | import { GridLabeler } from './GridLabeler';
9 | import { GridType } from './GridType';
10 | import { GridTypeUtils } from './GridTypeUtils';
11 |
12 | /**
13 | * Grid
14 | */
15 | export class Grid extends BaseGrid implements IComparable