cic-staff-client/docs/compodoc/modules/SharedModule.html
Spencer Ofwiti 8db1343bc5 Add docs.
2021-05-10 21:56:20 +03:00

461 lines
21 KiB
HTML

<!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 module">
<div class="content-data">
<ol class="breadcrumb">
<li>Modules</li>
<li>SharedModule</li>
</ol>
<div class="text-center module-graph-container">
<div id="module-graph-svg">
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 2.47.0 (20210316.0004)
-->
<!-- Title: dependencies Pages: 1 -->
<svg width="1160pt" height="284pt"
viewBox="0.00 0.00 1160.00 284.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 280)">
<title>dependencies</title>
<polygon fill="white" stroke="transparent" points="-4,4 -4,-280 1156,-280 1156,4 -4,4"/>
<text text-anchor="start" x="555.01" y="-42.4" font-family="sans-serif" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="342,-10 342,-30 362,-30 362,-10 342,-10"/>
<text text-anchor="start" x="365.63" y="-15.4" font-family="sans-serif" font-size="14.00"> &#160;Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="455,-10 455,-30 475,-30 475,-10 455,-10"/>
<text text-anchor="start" x="478.73" y="-15.4" font-family="sans-serif" font-size="14.00"> &#160;Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="541,-10 541,-30 561,-30 561,-10 541,-10"/>
<text text-anchor="start" x="564.78" y="-15.4" font-family="sans-serif" font-size="14.00"> &#160;Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="638,-10 638,-30 658,-30 658,-10 638,-10"/>
<text text-anchor="start" x="661.67" y="-15.4" font-family="sans-serif" font-size="14.00"> &#160;Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="734,-10 734,-30 754,-30 754,-10 734,-10"/>
<text text-anchor="start" x="757.73" y="-15.4" font-family="sans-serif" font-size="14.00"> &#160;Exports</text>
<g id="clust1" class="cluster">
<title>cluster_SharedModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-70 8,-268 1144,-268 1144,-70 8,-70"/>
</g>
<g id="clust12" class="cluster">
<title>cluster_SharedModule_exports</title>
<polygon fill="none" stroke="black" points="122,-208 122,-260 939,-260 939,-208 122,-208"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_SharedModule_declarations</title>
<polygon fill="none" stroke="black" points="16,-78 16,-130 1136,-130 1136,-78 16,-78"/>
</g>
<!-- ErrorDialogComponent -->
<g id="node1" class="node">
<title>ErrorDialogComponent</title>
<polygon fill="#ffffb3" stroke="black" points="1128.47,-122 979.53,-122 979.53,-86 1128.47,-86 1128.47,-122"/>
<text text-anchor="middle" x="1054" y="-99.8" font-family="Times,serif" font-size="14.00">ErrorDialogComponent</text>
</g>
<!-- SharedModule -->
<g id="node9" class="node">
<title>SharedModule</title>
<polygon fill="#8dd3c7" stroke="black" points="573.42,-187 570.42,-191 549.42,-191 546.42,-187 474.58,-187 474.58,-151 573.42,-151 573.42,-187"/>
<text text-anchor="middle" x="524" y="-164.8" font-family="Times,serif" font-size="14.00">SharedModule</text>
</g>
<!-- ErrorDialogComponent&#45;&gt;SharedModule -->
<g id="edge1" class="edge">
<title>ErrorDialogComponent&#45;&gt;SharedModule</title>
<path fill="none" stroke="black" d="M1054,-122.11C1054,-141.34 1054,-169 1054,-169 1054,-169 583.39,-169 583.39,-169"/>
<polygon fill="black" stroke="black" points="583.39,-165.5 573.39,-169 583.39,-172.5 583.39,-165.5"/>
</g>
<!-- FooterComponent -->
<g id="node2" class="node">
<title>FooterComponent</title>
<polygon fill="#ffffb3" stroke="black" points="961.88,-122 844.12,-122 844.12,-86 961.88,-86 961.88,-122"/>
<text text-anchor="middle" x="903" y="-99.8" font-family="Times,serif" font-size="14.00">FooterComponent</text>
</g>
<!-- FooterComponent&#45;&gt;SharedModule -->
<g id="edge2" class="edge">
<title>FooterComponent&#45;&gt;SharedModule</title>
<path fill="none" stroke="black" d="M887.38,-122.02C887.38,-139.37 887.38,-163 887.38,-163 887.38,-163 583.38,-163 583.38,-163"/>
<polygon fill="black" stroke="black" points="583.38,-159.5 573.38,-163 583.38,-166.5 583.38,-159.5"/>
</g>
<!-- MenuSelectionDirective -->
<g id="node3" class="node">
<title>MenuSelectionDirective</title>
<polygon fill="#ffffb3" stroke="black" points="826.34,-122 673.66,-122 673.66,-86 826.34,-86 826.34,-122"/>
<text text-anchor="middle" x="750" y="-99.8" font-family="Times,serif" font-size="14.00">MenuSelectionDirective</text>
</g>
<!-- MenuSelectionDirective&#45;&gt;SharedModule -->
<g id="edge3" class="edge">
<title>MenuSelectionDirective&#45;&gt;SharedModule</title>
<path fill="none" stroke="black" d="M732.38,-122.24C732.38,-137.57 732.38,-157 732.38,-157 732.38,-157 583.38,-157 583.38,-157"/>
<polygon fill="black" stroke="black" points="583.38,-153.5 573.38,-157 583.38,-160.5 583.38,-153.5"/>
</g>
<!-- MenuToggleDirective -->
<g id="node4" class="node">
<title>MenuToggleDirective</title>
<polygon fill="#ffffb3" stroke="black" points="655.4,-122 514.6,-122 514.6,-86 655.4,-86 655.4,-122"/>
<text text-anchor="middle" x="585" y="-99.8" font-family="Times,serif" font-size="14.00">MenuToggleDirective</text>
</g>
<!-- MenuToggleDirective&#45;&gt;SharedModule -->
<g id="edge4" class="edge">
<title>MenuToggleDirective&#45;&gt;SharedModule</title>
<path fill="none" stroke="black" d="M544.01,-122.11C544.01,-122.11 544.01,-140.99 544.01,-140.99"/>
<polygon fill="black" stroke="black" points="540.51,-140.99 544.01,-150.99 547.51,-140.99 540.51,-140.99"/>
</g>
<!-- SafePipe -->
<g id="node5" class="node">
<title>SafePipe</title>
<polygon fill="#ffffb3" stroke="black" points="496.76,-122 431.24,-122 431.24,-86 496.76,-86 496.76,-122"/>
<text text-anchor="middle" x="464" y="-99.8" font-family="Times,serif" font-size="14.00">SafePipe</text>
</g>
<!-- SafePipe&#45;&gt;SharedModule -->
<g id="edge5" class="edge">
<title>SafePipe&#45;&gt;SharedModule</title>
<path fill="none" stroke="black" d="M485.83,-122.11C485.83,-122.11 485.83,-140.99 485.83,-140.99"/>
<polygon fill="black" stroke="black" points="482.33,-140.99 485.83,-150.99 489.33,-140.99 482.33,-140.99"/>
</g>
<!-- SidebarComponent -->
<g id="node6" class="node">
<title>SidebarComponent</title>
<polygon fill="#ffffb3" stroke="black" points="413.1,-122 288.9,-122 288.9,-86 413.1,-86 413.1,-122"/>
<text text-anchor="middle" x="351" y="-99.8" font-family="Times,serif" font-size="14.00">SidebarComponent</text>
</g>
<!-- SidebarComponent&#45;&gt;SharedModule -->
<g id="edge6" class="edge">
<title>SidebarComponent&#45;&gt;SharedModule</title>
<path fill="none" stroke="black" d="M407.62,-122.24C407.62,-137.57 407.62,-157 407.62,-157 407.62,-157 464.65,-157 464.65,-157"/>
<polygon fill="black" stroke="black" points="464.65,-160.5 474.65,-157 464.65,-153.5 464.65,-160.5"/>
</g>
<!-- TokenRatioPipe -->
<g id="node7" class="node">
<title>TokenRatioPipe</title>
<polygon fill="#ffffb3" stroke="black" points="270.49,-122 163.51,-122 163.51,-86 270.49,-86 270.49,-122"/>
<text text-anchor="middle" x="217" y="-99.8" font-family="Times,serif" font-size="14.00">TokenRatioPipe</text>
</g>
<!-- TokenRatioPipe&#45;&gt;SharedModule -->
<g id="edge7" class="edge">
<title>TokenRatioPipe&#45;&gt;SharedModule</title>
<path fill="none" stroke="black" d="M263.06,-122.02C263.06,-139.37 263.06,-163 263.06,-163 263.06,-163 464.61,-163 464.61,-163"/>
<polygon fill="black" stroke="black" points="464.61,-166.5 474.61,-163 464.61,-159.5 464.61,-166.5"/>
</g>
<!-- TopbarComponent -->
<g id="node8" class="node">
<title>TopbarComponent</title>
<polygon fill="#ffffb3" stroke="black" points="145.76,-122 24.24,-122 24.24,-86 145.76,-86 145.76,-122"/>
<text text-anchor="middle" x="85" y="-99.8" font-family="Times,serif" font-size="14.00">TopbarComponent</text>
</g>
<!-- TopbarComponent&#45;&gt;SharedModule -->
<g id="edge8" class="edge">
<title>TopbarComponent&#45;&gt;SharedModule</title>
<path fill="none" stroke="black" d="M138.12,-122.11C138.12,-141.34 138.12,-169 138.12,-169 138.12,-169 464.74,-169 464.74,-169"/>
<polygon fill="black" stroke="black" points="464.74,-172.5 474.74,-169 464.74,-165.5 464.74,-172.5"/>
</g>
<!-- FooterComponent -->
<g id="node10" class="node">
<title>FooterComponent </title>
<polygon fill="#fb8072" stroke="black" points="930.88,-252 809.12,-252 809.12,-216 930.88,-216 930.88,-252"/>
<text text-anchor="middle" x="870" y="-229.8" font-family="Times,serif" font-size="14.00">FooterComponent </text>
</g>
<!-- SharedModule&#45;&gt;FooterComponent -->
<g id="edge9" class="edge">
<title>SharedModule&#45;&gt;FooterComponent </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M573.52,-175C657.27,-175 817.86,-175 817.86,-175 817.86,-175 817.86,-205.98 817.86,-205.98"/>
<polygon fill="black" stroke="black" points="814.36,-205.98 817.86,-215.98 821.36,-205.98 814.36,-205.98"/>
</g>
<!-- MenuSelectionDirective -->
<g id="node11" class="node">
<title>MenuSelectionDirective </title>
<polygon fill="#fb8072" stroke="black" points="791.34,-252 634.66,-252 634.66,-216 791.34,-216 791.34,-252"/>
<text text-anchor="middle" x="713" y="-229.8" font-family="Times,serif" font-size="14.00">MenuSelectionDirective </text>
</g>
<!-- SharedModule&#45;&gt;MenuSelectionDirective -->
<g id="edge10" class="edge">
<title>SharedModule&#45;&gt;MenuSelectionDirective </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M573.22,-181C606.73,-181 645.01,-181 645.01,-181 645.01,-181 645.01,-205.76 645.01,-205.76"/>
<polygon fill="black" stroke="black" points="641.51,-205.76 645.01,-215.76 648.51,-205.76 641.51,-205.76"/>
</g>
<!-- SafePipe -->
<g id="node12" class="node">
<title>SafePipe </title>
<polygon fill="#fb8072" stroke="black" points="616.76,-252 547.24,-252 547.24,-216 616.76,-216 616.76,-252"/>
<text text-anchor="middle" x="582" y="-229.8" font-family="Times,serif" font-size="14.00">SafePipe </text>
</g>
<!-- SharedModule&#45;&gt;SafePipe -->
<g id="edge11" class="edge">
<title>SharedModule&#45;&gt;SafePipe </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M560.29,-187.11C560.29,-187.11 560.29,-205.99 560.29,-205.99"/>
<polygon fill="black" stroke="black" points="556.79,-205.99 560.29,-215.99 563.79,-205.99 556.79,-205.99"/>
</g>
<!-- SidebarComponent -->
<g id="node13" class="node">
<title>SidebarComponent </title>
<polygon fill="#fb8072" stroke="black" points="529.6,-252 402.4,-252 402.4,-216 529.6,-216 529.6,-252"/>
<text text-anchor="middle" x="466" y="-229.8" font-family="Times,serif" font-size="14.00">SidebarComponent </text>
</g>
<!-- SharedModule&#45;&gt;SidebarComponent -->
<g id="edge12" class="edge">
<title>SharedModule&#45;&gt;SidebarComponent </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M502.29,-187.11C502.29,-187.11 502.29,-205.99 502.29,-205.99"/>
<polygon fill="black" stroke="black" points="498.79,-205.99 502.29,-215.99 505.79,-205.99 498.79,-205.99"/>
</g>
<!-- TokenRatioPipe -->
<g id="node14" class="node">
<title>TokenRatioPipe </title>
<polygon fill="#fb8072" stroke="black" points="384.49,-252 273.51,-252 273.51,-216 384.49,-216 384.49,-252"/>
<text text-anchor="middle" x="329" y="-229.8" font-family="Times,serif" font-size="14.00">TokenRatioPipe </text>
</g>
<!-- SharedModule&#45;&gt;TokenRatioPipe -->
<g id="edge13" class="edge">
<title>SharedModule&#45;&gt;TokenRatioPipe </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M474.76,-181C419.24,-181 336.6,-181 336.6,-181 336.6,-181 336.6,-205.76 336.6,-205.76"/>
<polygon fill="black" stroke="black" points="333.1,-205.76 336.6,-215.76 340.1,-205.76 333.1,-205.76"/>
</g>
<!-- TopbarComponent -->
<g id="node15" class="node">
<title>TopbarComponent </title>
<polygon fill="#fb8072" stroke="black" points="255.76,-252 130.24,-252 130.24,-216 255.76,-216 255.76,-252"/>
<text text-anchor="middle" x="193" y="-229.8" font-family="Times,serif" font-size="14.00">TopbarComponent </text>
</g>
<!-- SharedModule&#45;&gt;TopbarComponent -->
<g id="edge14" class="edge">
<title>SharedModule&#45;&gt;TopbarComponent </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M474.52,-175C385.98,-175 209.57,-175 209.57,-175 209.57,-175 209.57,-205.98 209.57,-205.98"/>
<polygon fill="black" stroke="black" points="206.07,-205.98 209.57,-215.98 213.07,-205.98 206.07,-205.98"/>
</g>
</g>
</svg>
</div>
<i id="fullscreen" class="icon ion-ios-resize module-graph-fullscreen-btn" aria-hidden="true"></i>
<div class="btn-group">
<button id="zoom-in" class="btn btn-default btn-sm">Zoom in</button>
<button id="reset" class="btn btn-default btn-sm">Reset</button>
<button id="zoom-out" class="btn btn-default btn-sm">Zoom out</button>
</div>
</div>
<script src="../js/libs/svg-pan-zoom.min.js"></script>
<script src="../js/svg-pan-zoom.controls.js"></script>
<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/shared/shared.module.ts</code>
</p>
<div class="container-fluid module">
<div class="row">
<div class="col-sm-3">
<h3>Declarations<a href="https://angular.io/api/core/NgModule#declarations" target="_blank"
title="Official documentation about module declarations"><span class="icon ion-ios-information-circle-outline"></span></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../components/ErrorDialogComponent.html">ErrorDialogComponent</a>
</li>
<li class="list-group-item">
<a href="../components/FooterComponent.html">FooterComponent</a>
</li>
<li class="list-group-item">
<a href="../directives/MenuSelectionDirective.html">MenuSelectionDirective</a>
</li>
<li class="list-group-item">
<a href="../directives/MenuToggleDirective.html">MenuToggleDirective</a>
</li>
<li class="list-group-item">
<a href="../pipes/SafePipe.html">SafePipe</a>
</li>
<li class="list-group-item">
<a href="../components/SidebarComponent.html">SidebarComponent</a>
</li>
<li class="list-group-item">
<a href="../pipes/TokenRatioPipe.html">TokenRatioPipe</a>
</li>
<li class="list-group-item">
<a href="../components/TopbarComponent.html">TopbarComponent</a>
</li>
</ul>
</div>
<div class="col-sm-3">
<h3>Exports<a href="https://angular.io/api/core/NgModule#exports" target="_blank" title="Official documentation about module exports"><span
class="icon ion-ios-information-circle-outline"></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../components/FooterComponent.html">FooterComponent</a>
</li>
<li class="list-group-item">
<a href="../directives/MenuSelectionDirective.html">MenuSelectionDirective</a>
</li>
<li class="list-group-item">
<a href="../pipes/SafePipe.html">SafePipe</a>
</li>
<li class="list-group-item">
<a href="../components/SidebarComponent.html">SidebarComponent</a>
</li>
<li class="list-group-item">
<a href="../pipes/TokenRatioPipe.html">TokenRatioPipe</a>
</li>
<li class="list-group-item">
<a href="../components/TopbarComponent.html">TopbarComponent</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { NgModule } from &#x27;@angular/core&#x27;;
import { CommonModule } from &#x27;@angular/common&#x27;;
import { TopbarComponent } from &#x27;@app/shared/topbar/topbar.component&#x27;;
import { FooterComponent } from &#x27;@app/shared/footer/footer.component&#x27;;
import { SidebarComponent } from &#x27;@app/shared/sidebar/sidebar.component&#x27;;
import { MenuSelectionDirective } from &#x27;@app/shared/_directives/menu-selection.directive&#x27;;
import { MenuToggleDirective } from &#x27;@app/shared/_directives/menu-toggle.directive&#x27;;
import {RouterModule} from &#x27;@angular/router&#x27;;
import {MatIconModule} from &#x27;@angular/material/icon&#x27;;
import {TokenRatioPipe} from &#x27;@app/shared/_pipes/token-ratio.pipe&#x27;;
import { ErrorDialogComponent } from &#x27;@app/shared/error-dialog/error-dialog.component&#x27;;
import {MatDialogModule} from &#x27;@angular/material/dialog&#x27;;
import { SafePipe } from &#x27;@app/shared/_pipes/safe.pipe&#x27;;
@NgModule({
declarations: [
TopbarComponent,
FooterComponent,
SidebarComponent,
MenuSelectionDirective,
MenuToggleDirective,
TokenRatioPipe,
ErrorDialogComponent,
SafePipe
],
exports: [
TopbarComponent,
FooterComponent,
SidebarComponent,
MenuSelectionDirective,
TokenRatioPipe,
SafePipe
],
imports: [
CommonModule,
RouterModule,
MatIconModule,
MatDialogModule,
]
})
export class SharedModule { }
</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 = 'module';
var COMPODOC_CURRENT_PAGE_URL = 'SharedModule.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>