blob: b336dffc0c9155fef9649230e12fe578970122c7 [file] [log] [blame]
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>helix-front documentation</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">
<link rel="stylesheet" href="../styles/dark.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="../" class="navbar-brand">helix-front documentation</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 interface">
<div class="content-data">
<ol class="breadcrumb">
<li>Interfaces</li>
<li
>
MapFieldObject</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/shared/models/node.model.ts</code>
</p>
<section>
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<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="#name"
>
name
</a>
</li>
<li>
<a href="#value"
>
value
</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="inputs">Properties</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="name"></a>
<span class="name "><b>name</b>
<a href="#name">
<span class="icon ion-ios-link"></span>
</a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>name: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</code>
</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/string" target="_blank" >string</a></code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="value"></a>
<span class="name "><b>value</b>
<a href="#value">
<span class="icon ion-ios-link"></span>
</a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>value: <code><a href="../interfaces/SimpleFieldObject.html" target="_self" >SimpleFieldObject[]</a></code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../interfaces/SimpleFieldObject.html" target="_self" >SimpleFieldObject[]</a></code>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import * as _ from &#x27;lodash&#x27;;
interface SimpleFieldObject {
name: string;
value: string;
}
interface ListFieldObject {
name: string;
value: SimpleFieldObject[];
}
interface MapFieldObject {
name: string;
value: SimpleFieldObject[];
}
interface Payload {
id: string;
simpleFields?: any;
listFields?: any;
mapFields?: any;
}
// This is a typical Helix Node definition
export class Node {
id: string;
simpleFields: SimpleFieldObject[] &#x3D; [];
listFields: ListFieldObject[] &#x3D; [];
mapFields: MapFieldObject[] &#x3D; [];
constructor(obj: any) {
if (obj !&#x3D; null) {
this.id &#x3D; obj.id;
this.simpleFields &#x3D; this.keyValueToArray(obj.simpleFields);
_.forOwn(obj[&#x27;listFields&#x27;], (v, k) &#x3D;&gt; {
this.listFields.push(&lt;ListFieldObject&gt;{
name: k,
value: _.map(
v,
(item) &#x3D;&gt;
&lt;SimpleFieldObject&gt;{
value: item,
}
),
});
});
_.forOwn(obj[&#x27;mapFields&#x27;], (v, k) &#x3D;&gt; {
this.mapFields.push(&lt;MapFieldObject&gt;{
name: k.trim(),
value: this.keyValueToArray(v),
});
});
}
}
public appendSimpleField(name: string, value: string) {
this.simpleFields.push(&lt;SimpleFieldObject&gt;{
name,
value,
});
}
public appendMapField(key: string, name: string, value: string) {
const index &#x3D; _.findIndex(this.mapFields, { name: key });
if (index &gt;&#x3D; 0) {
this.mapFields[index].value.push(&lt;SimpleFieldObject&gt;{
name: name.trim(),
value,
});
} else {
this.mapFields.push(&lt;MapFieldObject&gt;{
name: key,
value: [
&lt;SimpleFieldObject&gt;{
name: name.trim(),
value,
},
],
});
}
}
public json(id: string): string {
const obj: Payload &#x3D; {
id,
};
if (this?.simpleFields.length &gt; 0) {
obj.simpleFields &#x3D; {};
_.forEach(this.simpleFields, (item: SimpleFieldObject) &#x3D;&gt; {
obj.simpleFields[item.name] &#x3D; item.value;
});
}
if (this?.listFields.length &gt; 0) {
obj.listFields &#x3D; {};
_.forEach(this.listFields, (item: ListFieldObject) &#x3D;&gt; {
obj.listFields[item.name] &#x3D; [];
_.forEach(item.value, (subItem: SimpleFieldObject) &#x3D;&gt; {
obj.listFields[item.name].push(subItem.value);
});
});
}
if (this?.mapFields.length &gt; 0) {
obj.mapFields &#x3D; {};
_.forEach(this.mapFields, (item: MapFieldObject) &#x3D;&gt; {
obj.mapFields[item.name.trim()] &#x3D; item.value ? {} : null;
_.forEach(item.value, (subItem: SimpleFieldObject) &#x3D;&gt; {
// if the value is a string that contains all digits, parse it to a number
let parsedValue: string | number &#x3D; subItem.value;
if (
typeof subItem.value &#x3D;&#x3D;&#x3D; &#x27;string&#x27; &amp;&amp;
/^\d+$/.test(subItem.value)
) {
parsedValue &#x3D; Number(subItem.value);
}
obj.mapFields[item.name.trim()][subItem.name] &#x3D; parsedValue;
});
});
}
return JSON.stringify(obj);
}
// Converting raw simpleFields to SimpleFieldObject[]
private keyValueToArray(obj: Object): SimpleFieldObject[] {
const result: SimpleFieldObject[] &#x3D; [];
for (const k in obj) {
if (obj.hasOwnProperty(k)) {
result.push(&lt;SimpleFieldObject&gt;{
name: k,
value: obj[k],
});
}
}
return result;
}
}
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results 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>
<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface';
var COMPODOC_CURRENT_PAGE_URL = 'MapFieldObject.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<script src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.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>