Skip to content

Commit

Permalink
[ci skip] Updating documents
Browse files Browse the repository at this point in the history
  • Loading branch information
ci-build committed Aug 12, 2024
1 parent 6595efe commit 1434dee
Show file tree
Hide file tree
Showing 55 changed files with 10,326 additions and 3,209 deletions.
114 changes: 71 additions & 43 deletions additional-documentation/rest-api.html
View file

Large diffs are not rendered by default.

301 changes: 301 additions & 0 deletions classes/DashboardConfig.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,301 @@
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>ReDBox Portal - NG2 Apps</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">
<link rel="stylesheet" href="../styles/postmark.css">
</head>
<body>
<script>
// Blocking script to avoid flickering dark mode
// Dark mode toggle button
var useDark = window.matchMedia('(prefers-color-scheme: dark)');
var darkModeState = useDark.matches;
var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');

function checkToggle(check) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].checked = check;
}
}

function toggleDarkMode(state) {
if (window.localStorage) {
localStorage.setItem('compodoc_darkmode-state', state);
}

checkToggle(state);

const hasClass = document.body.classList.contains('dark');

if (state) {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.add('dark');
}
if (!hasClass) {
document.body.classList.add('dark');
}
} else {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.remove('dark');
}
if (hasClass) {
document.body.classList.remove('dark');
}
}
}

useDark.addEventListener('change', function (evt) {
toggleDarkMode(evt.matches);
});
if (darkModeStateLocal) {
darkModeState = darkModeStateLocal === 'true';
}
toggleDarkMode(darkModeState);
</script>

<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
<div class="d-flex">
<a href="../" class="navbar-brand">ReDBox Portal - NG2 Apps</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
</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="d-none d-md-block menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content class">
<div class="content-data">












<ol class="breadcrumb">
<li class="breadcrumb-item">Classes</li>
<li class="breadcrumb-item" >DashboardConfig</li>
</ol>

<ul class="nav nav-tabs" role="tablist">
<li class="nav-item">
<a href="#info"
class="nav-link"
class="nav-link active"
role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a>
</li>
<li class="nav-item">
<a href="#source"
class="nav-link"

role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a>
</li>
</ul>

<div class="tab-content">
<div class="tab-pane fade active in" id="info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>angular/projects/researchdatabox/portal-ng-common/src/lib/dashboard-models.ts</code>
</p>










<section data-compodoc="block-indexables">
<h3 id="inputs">Indexable</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<code>[key: string]: <code>literal type</code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="53" class="link-to-prism">angular/projects/researchdatabox/portal-ng-common/src/lib/dashboard-models.ts:53</a></div>
</td>
</tr>
</tbody>
</table>
</section>





</div>


<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">export class PlanTable {
totalItems: number &#x3D; 0;
currentPage: number &#x3D; 0;
noItems: number &#x3D; 0;
items: any[] &#x3D; [];
}

export class RecordResponseTable {
totalItems: number &#x3D; 0;
currentPage: number &#x3D; 0;
noItems: number &#x3D; 0;
items: any[] &#x3D; [];
}

export class Plan {
oid: string &#x3D; &#x27;&#x27;;
title: string &#x3D; &#x27;&#x27;;
dateCreated: string &#x3D; &#x27;&#x27;;
dateModified: string &#x3D; &#x27;&#x27;;
hasEditAccess:boolean &#x3D; false;
metadata: object &#x3D; {};
dashboardTitle: string &#x3D; &#x27;&#x27;;
}

export declare class FilterField {
name: string;
path: string;
}

export declare class QueryFilter {
filterType: string;
filterFields: FilterField[];
}

export declare class SortGroupBy {
rowLevel: number;
compareFieldValue: string;
compareField: string;
relatedTo: string;
}

export declare class FormatRules {
filterBy: any;
filterWorkflowStepsBy: string[];
recordTypeFilterBy: string;
queryFilters: { [key: string]: QueryFilter[] };
sortBy: string;
groupBy: string;
sortGroupBy: SortGroupBy[];
hideWorkflowStepTitleForRecordType: string[];
}

export declare class DashboardConfig {
[key: string]: {
formatRules: FormatRules;
}
}</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 = 'class';
var COMPODOC_CURRENT_PAGE_URL = 'DashboardConfig.html';
var MAX_SEARCH_RESULTS = 15;
</script>

<script>
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
checkToggle(darkModeState);
if ($darkModeToggleSwitchers.length > 0) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
darkModeState = !darkModeState;
toggleDarkMode(darkModeState);
});
}
}
</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>
Loading

0 comments on commit 1434dee

Please sign in to comment.