grassrootseconomics/cic-staff-client
5
0
Fork 0
Code Issues 26 Pull Requests Projects Releases Wiki Activity
spencer/accounts-web-workers
cic-staff-client/docs/compodoc/injectables/LocationService.html

759 lines
28 KiB
HTML
Raw Permalink Normal View History

Add docs.
2021-05-10 20:56:20 +02:00
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>CICADA</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="../" class="navbar-brand">CICADA</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content injectable">
<div class="content-data">
<ol class="breadcrumb">
<li>Injectables</li>
<li>LocationService</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="active">
<a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
</li>
<li >
<a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="c-info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/app/_services/location.service.ts</code>
</p>
<section>
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#areaNames">areaNames</a>
</li>
<li>
<span class="modifier">Private</span>
<a href="#areaNamesList">areaNamesList</a>
</li>
<li>
<a href="#areaNamesSubject">areaNamesSubject</a>
</li>
<li>
<a href="#areaTypes">areaTypes</a>
</li>
<li>
<span class="modifier">Private</span>
<a href="#areaTypesList">areaTypesList</a>
</li>
<li>
<a href="#areaTypesSubject">areaTypesSubject</a>
</li>
</ul>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
<tr>
<td class="col-md-4">
<h6><b>Methods</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#getAreaNameByLocation">getAreaNameByLocation</a>
</li>
<li>
<a href="#getAreaNames">getAreaNames</a>
</li>
<li>
<a href="#getAreaTypeByArea">getAreaTypeByArea</a>
</li>
<li>
<a href="#getAreaTypes">getAreaTypes</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="constructor">Constructor</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(httpClient: <a href="https://angular.io/api/common/http/HttpClient" target="_blank">HttpClient</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
<div class="io-line">Defined in <a href="" data-line="17" class="link-to-prism">src/app/_services/location.service.ts:17</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>httpClient</td>
<td>
<code><a href="https://angular.io/api/common/http/HttpClient" target="_blank" >HttpClient</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getAreaNameByLocation"></a>
<span class="name">
<b>
getAreaNameByLocation
</b>
<a href="#getAreaNameByLocation"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
<code>getAreaNameByLocation(location: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, areaNames: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object" target="_blank">object</a>)</code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
<div class="io-line">Defined in <a href="" data-line="28"
class="link-to-prism">src/app/_services/location.service.ts:28</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>location</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
</tr>
<tr>
<td>areaNames</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object" target="_blank" >object</a></code>
</td>
<td>
No
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
<b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
Add docs.
2021-05-10 20:56:20 +02:00
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getAreaNames"></a>
<span class="name">
<b>
getAreaNames
</b>
<a href="#getAreaNames"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>getAreaNames()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
<div class="io-line">Defined in <a href="" data-line="21"
class="link-to-prism">src/app/_services/location.service.ts:21</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
Add docs.
2021-05-10 20:56:20 +02:00
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getAreaTypeByArea"></a>
<span class="name">
<b>
getAreaTypeByArea
</b>
<a href="#getAreaTypeByArea"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
<code>getAreaTypeByArea(area: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, areaTypes: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object" target="_blank">object</a>)</code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
<div class="io-line">Defined in <a href="" data-line="47"
class="link-to-prism">src/app/_services/location.service.ts:47</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>area</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
</tr>
<tr>
<td>areaTypes</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object" target="_blank" >object</a></code>
</td>
<td>
No
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
<b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
Add docs.
2021-05-10 20:56:20 +02:00
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getAreaTypes"></a>
<span class="name">
<b>
getAreaTypes
</b>
<a href="#getAreaTypes"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>getAreaTypes()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
<div class="io-line">Defined in <a href="" data-line="40"
class="link-to-prism">src/app/_services/location.service.ts:40</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
Add docs.
2021-05-10 20:56:20 +02:00
</div>
</td>
</tr>
</tbody>
</table>
</section>
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
<section>
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="areaNames"></a>
<span class="name">
<b>
areaNames</b>
<a href="#areaNames"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object" target="_blank" >object</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>{}</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="11" class="link-to-prism">src/app/_services/location.service.ts:11</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="areaNamesList"></a>
<span class="name">
<b>
<span class="modifier">Private</span>
areaNamesList</b>
<a href="#areaNamesList"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>BehaviorSubject&lt;object&gt;</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>new BehaviorSubject&lt;object&gt;(this.areaNames)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="12" class="link-to-prism">src/app/_services/location.service.ts:12</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="areaNamesSubject"></a>
<span class="name">
<b>
areaNamesSubject</b>
<a href="#areaNamesSubject"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>Observable&lt;object&gt;</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>this.areaNamesList.asObservable()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="13" class="link-to-prism">src/app/_services/location.service.ts:13</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="areaTypes"></a>
<span class="name">
<b>
areaTypes</b>
<a href="#areaTypes"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object" target="_blank" >object</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>{}</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="15" class="link-to-prism">src/app/_services/location.service.ts:15</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="areaTypesList"></a>
<span class="name">
<b>
<span class="modifier">Private</span>
areaTypesList</b>
<a href="#areaTypesList"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>BehaviorSubject&lt;object&gt;</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>new BehaviorSubject&lt;object&gt;(this.areaTypes)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="16" class="link-to-prism">src/app/_services/location.service.ts:16</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="areaTypesSubject"></a>
<span class="name">
<b>
areaTypesSubject</b>
<a href="#areaTypesSubject"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>Observable&lt;object&gt;</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>this.areaTypesList.asObservable()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="17" class="link-to-prism">src/app/_services/location.service.ts:17</a></div>
</td>
</tr>
</tbody>
</table>
</section>
Add docs.
2021-05-10 20:56:20 +02:00
</div>
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { Injectable } from &#x27;@angular/core&#x27;;
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
import { BehaviorSubject, Observable } from &#x27;rxjs&#x27;;
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
import { environment } from &#x27;@src/environments/environment&#x27;;
import { first } from &#x27;rxjs/operators&#x27;;
import { HttpClient } from &#x27;@angular/common/http&#x27;;
Add docs.
2021-05-10 20:56:20 +02:00
@Injectable({
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
providedIn: &#x27;root&#x27;,
Add docs.
2021-05-10 20:56:20 +02:00
})
export class LocationService {
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
areaNames: object &#x3D; {};
private areaNamesList: BehaviorSubject&lt;object&gt; &#x3D; new BehaviorSubject&lt;object&gt;(this.areaNames);
areaNamesSubject: Observable&lt;object&gt; &#x3D; this.areaNamesList.asObservable();
areaTypes: object &#x3D; {};
private areaTypesList: BehaviorSubject&lt;object&gt; &#x3D; new BehaviorSubject&lt;object&gt;(this.areaTypes);
areaTypesSubject: Observable&lt;object&gt; &#x3D; this.areaTypesList.asObservable();
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
constructor(private httpClient: HttpClient) {}
Add docs.
2021-05-10 20:56:20 +02:00
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
getAreaNames(): void {
this.httpClient
.get(&#x60;${environment.cicMetaUrl}/areanames&#x60;)
.pipe(first())
.subscribe((res: object) &#x3D;&gt; this.areaNamesList.next(res));
Add docs.
2021-05-10 20:56:20 +02:00
}
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
getAreaNameByLocation(location: string, areaNames: object): string {
const keywords &#x3D; location.toLowerCase().split(&#x27; &#x27;);
for (const keyword of keywords) {
const queriedAreaName: string &#x3D; Object.keys(areaNames).find((key) &#x3D;&gt;
areaNames[key].includes(keyword)
);
if (queriedAreaName) {
return queriedAreaName;
}
}
Add docs.
2021-05-10 20:56:20 +02:00
}
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
getAreaTypes(): void {
this.httpClient
.get(&#x60;${environment.cicMetaUrl}/areatypes&#x60;)
.pipe(first())
.subscribe((res: object) &#x3D;&gt; this.areaTypesList.next(res));
Add docs.
2021-05-10 20:56:20 +02:00
}
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
getAreaTypeByArea(area: string, areaTypes: object): string {
const keywords &#x3D; area.toLowerCase().split(&#x27; &#x27;);
for (const keyword of keywords) {
const queriedAreaType: string &#x3D; Object.keys(areaTypes).find((key) &#x3D;&gt;
areaTypes[key].includes(keyword)
);
if (queriedAreaType) {
return queriedAreaType;
}
}
Add docs.
2021-05-10 20:56:20 +02:00
}
}
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'injectable';
var COMPODOC_CURRENT_PAGE_URL = 'LocationService.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<!-- Required to polyfill modern browsers as code is ES5 for IE... -->
<script src="../js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script>
<script src="../js/menu-wc.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
</body>
</html>
Reference in New Issue Copy Permalink