@inaut/math-functions
Version:
Executes code-lines with function calls like Excel
805 lines • 64.9 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BaseFunction | @inaut/math-functions</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@inaut/math-functions</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_math_functions_functions_base_function_.html">"math-functions/functions/base-function"</a>
</li>
<li>
<a href="_math_functions_functions_base_function_.basefunction.html">BaseFunction</a>
</li>
</ul>
<h1>Class BaseFunction</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">BaseFunction</span>
<ul class="tsd-hierarchy">
<li>
<a href="_math_functions_functions_function_acos_.function_acos.html" class="tsd-signature-type">Function_ACOS</a>
</li>
<li>
<a href="_math_functions_functions_function_logical_operations_.logicaloperationfunction.html" class="tsd-signature-type">LogicalOperationFunction</a>
</li>
<li>
<a href="_math_functions_functions_function_asin_.function_asin.html" class="tsd-signature-type">Function_ASIN</a>
</li>
<li>
<a href="_math_functions_functions_function_atan_.function_atan.html" class="tsd-signature-type">Function_ATAN</a>
</li>
<li>
<a href="_math_functions_functions_function_binary_operation_.binaryoperation.html" class="tsd-signature-type">BinaryOperation</a>
</li>
<li>
<a href="_math_functions_functions_function_bnot_.function_bnot.html" class="tsd-signature-type">Function_BNOT</a>
</li>
<li>
<a href="_math_functions_functions_function_compare_operation_.comparefunction.html" class="tsd-signature-type">CompareFunction</a>
</li>
<li>
<a href="_math_functions_functions_function_concate_.function_concate.html" class="tsd-signature-type">Function_CONCATE</a>
</li>
<li>
<a href="_math_functions_functions_function_cos_.function_cos.html" class="tsd-signature-type">Function_COS</a>
</li>
<li>
<a href="_math_functions_functions_function_diff_.function_diff.html" class="tsd-signature-type">Function_DIFF</a>
</li>
<li>
<a href="_math_functions_functions_function_div_.function_div.html" class="tsd-signature-type">Function_DIV</a>
</li>
<li>
<a href="_math_functions_functions_function_get_array_element_.function_get_array_element.html" class="tsd-signature-type">Function_GET_ARRAY_ELEMENT</a>
</li>
<li>
<a href="_math_functions_functions_function_get_array_splice_.function_get_array_splice.html" class="tsd-signature-type">Function_GET_ARRAY_SPLICE</a>
</li>
<li>
<a href="_math_functions_functions_function_get_char_.function_get_char.html" class="tsd-signature-type">Function_GET_CHAR</a>
</li>
<li>
<a href="_math_functions_functions_function_get_date_time_.function_get_date_time.html" class="tsd-signature-type">Function_GET_DATE_TIME</a>
</li>
<li>
<a href="_math_functions_functions_function_get_day_.function_get_day.html" class="tsd-signature-type">Function_GET_DAY</a>
</li>
<li>
<a href="_math_functions_functions_function_get_dow_.function_get_dow.html" class="tsd-signature-type">Function_GET_DOW</a>
</li>
<li>
<a href="_math_functions_functions_function_get_hour_.function_get_hour.html" class="tsd-signature-type">Function_GET_HOUR</a>
</li>
<li>
<a href="_math_functions_functions_function_get_minute_.function_get_minute.html" class="tsd-signature-type">Function_GET_MINUTE</a>
</li>
<li>
<a href="_math_functions_functions_function_get_month_.function_get_month.html" class="tsd-signature-type">Function_GET_MONTH</a>
</li>
<li>
<a href="_math_functions_functions_function_get_second_.function_get_second.html" class="tsd-signature-type">Function_GET_SECOND</a>
</li>
<li>
<a href="_math_functions_functions_function_get_string_.function_get_string.html" class="tsd-signature-type">Function_GET_STRING</a>
</li>
<li>
<a href="_math_functions_functions_function_get_value_state_.function_get_value_state.html" class="tsd-signature-type">Function_GET_VALUE_STATE</a>
</li>
<li>
<a href="_math_functions_functions_function_get_value_ts_.function_get_value_ts.html" class="tsd-signature-type">Function_GET_VALUE_TS</a>
</li>
<li>
<a href="_math_functions_functions_function_get_value_.function_get_value.html" class="tsd-signature-type">Function_GET_VALUE</a>
</li>
<li>
<a href="_math_functions_functions_function_get_year_.function_get_year.html" class="tsd-signature-type">Function_GET_YEAR</a>
</li>
<li>
<a href="_math_functions_functions_function_if_error_.function_if_error.html" class="tsd-signature-type">Function_IF_ERROR</a>
</li>
<li>
<a href="_math_functions_functions_function_if_.function_if.html" class="tsd-signature-type">Function_IF</a>
</li>
<li>
<a href="_math_functions_functions_function_in_string_.function_in_string.html" class="tsd-signature-type">Function_IN_STRING</a>
</li>
<li>
<a href="_math_functions_functions_function_join_.function_join.html" class="tsd-signature-type">Function_JOIN</a>
</li>
<li>
<a href="_math_functions_functions_function_len_.function_len.html" class="tsd-signature-type">Function_LEN</a>
</li>
<li>
<a href="_math_functions_functions_function_max_.function_max.html" class="tsd-signature-type">Function_MAX</a>
</li>
<li>
<a href="_math_functions_functions_function_mean_.function_mean.html" class="tsd-signature-type">Function_MEAN</a>
</li>
<li>
<a href="_math_functions_functions_function_median_.function_median.html" class="tsd-signature-type">Function_MEDIAN</a>
</li>
<li>
<a href="_math_functions_functions_function_min_.function_min.html" class="tsd-signature-type">Function_MIN</a>
</li>
<li>
<a href="_math_functions_functions_function_mul_.function_mul.html" class="tsd-signature-type">Function_MUL</a>
</li>
<li>
<a href="_math_functions_functions_function_neg_edge_.function_neg_edge.html" class="tsd-signature-type">Function_NEG_EDGE</a>
</li>
<li>
<a href="_math_functions_functions_function_not_.function_not.html" class="tsd-signature-type">Function_NOT</a>
</li>
<li>
<a href="_math_functions_functions_function_pos_edge_.function_pos_edge.html" class="tsd-signature-type">Function_POS_EDGE</a>
</li>
<li>
<a href="_math_functions_functions_function_pos_in_string_.function_pos_in_string.html" class="tsd-signature-type">Function_POS_IN_STRING</a>
</li>
<li>
<a href="_math_functions_functions_function_pow_.function_pow.html" class="tsd-signature-type">Function_POW</a>
</li>
<li>
<a href="_math_functions_functions_function_random_.function_random.html" class="tsd-signature-type">Function_RANDOM</a>
</li>
<li>
<a href="_math_functions_functions_function_sum_.function_sum.html" class="tsd-signature-type">Function_SUM</a>
</li>
<li>
<a href="_math_functions_functions_function_sqrt_.function_sqrt.html" class="tsd-signature-type">Function_SQRT</a>
</li>
<li>
<a href="_math_functions_functions_function_trunc_.function_trunc.html" class="tsd-signature-type">Function_TRUNC</a>
</li>
<li>
<a href="_math_functions_functions_function_round_.function_round.html" class="tsd-signature-type">Function_ROUND</a>
</li>
<li>
<a href="_math_functions_functions_function_sin_.function_sin.html" class="tsd-signature-type">Function_SIN</a>
</li>
<li>
<a href="_math_functions_functions_function_tan_.function_tan.html" class="tsd-signature-type">Function_TAN</a>
</li>
<li>
<a href="_math_functions_functions_function_scale_.function_scale.html" class="tsd-signature-type">Function_SCALE</a>
</li>
<li>
<a href="_math_functions_functions_function_set_value_.function_set_value.html" class="tsd-signature-type">Function_SET_VALUE</a>
</li>
<li>
<a href="_math_functions_functions_function_value_changed_.function_value_changed.html" class="tsd-signature-type">Function_VALUE_CHANGED</a>
</li>
<li>
<a href="_math_functions_functions_function_pi_.function_pi.html" class="tsd-signature-type">Function_PI</a>
</li>
<li>
<a href="_math_functions_functions_function_split_.function_split.html" class="tsd-signature-type">Function_SPLIT</a>
</li>
<li>
<a href="_math_functions_functions_function_search_replace_.function_replace.html" class="tsd-signature-type">Function_REPLACE</a>
</li>
<li>
<a href="_math_functions_functions_function_trim_.function_trim.html" class="tsd-signature-type">Function_TRIM</a>
</li>
<li>
<a href="_math_functions_functions_function_trim_start_.function_trim_start.html" class="tsd-signature-type">Function_TRIM_START</a>
</li>
<li>
<a href="_math_functions_functions_function_trim_end_.function_trim_end.html" class="tsd-signature-type">Function_TRIM_END</a>
</li>
<li>
<a href="_math_functions_functions_function_to_lower_case_.function_to_lower_case.html" class="tsd-signature-type">Function_TO_LOWER_CASE</a>
</li>
<li>
<a href="_math_functions_functions_function_to_upper_case_.function_to_upper_case.html" class="tsd-signature-type">Function_TO_UPPER_CASE</a>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html" class="tsd-signature-type">IBaseFunction</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-private-protected">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-protected"><a href="_math_functions_functions_base_function_.basefunction.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_math_functions_functions_base_function_.basefunction.html#asyncron" class="tsd-kind-icon">asyncron</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_math_functions_functions_base_function_.basefunction.html#description" class="tsd-kind-icon">description</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_math_functions_functions_base_function_.basefunction.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_math_functions_functions_base_function_.basefunction.html#operation" class="tsd-kind-icon">operation</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_math_functions_functions_base_function_.basefunction.html#priority" class="tsd-kind-icon">priority</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_math_functions_functions_base_function_.basefunction.html#storing" class="tsd-kind-icon">storing</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_math_functions_functions_base_function_.basefunction.html#clone" class="tsd-kind-icon">clone</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_math_functions_functions_base_function_.basefunction.html#execute" class="tsd-kind-icon">execute</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_math_functions_functions_base_function_.basefunction.html#executeasync" class="tsd-kind-icon">execute<wbr>Async</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="_math_functions_functions_base_function_.basefunction.html#getargumenterror" class="tsd-kind-icon">get<wbr>Argument<wbr>Error</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_math_functions_functions_base_function_.basefunction.html#getdescription" class="tsd-kind-icon">get<wbr>Description</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_math_functions_functions_base_function_.basefunction.html#getname" class="tsd-kind-icon">get<wbr>Name</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_math_functions_functions_base_function_.basefunction.html#getoperator" class="tsd-kind-icon">get<wbr>Operator</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_math_functions_functions_base_function_.basefunction.html#getpriority" class="tsd-kind-icon">get<wbr>Priority</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="_math_functions_functions_base_function_.basefunction.html#hasargumenterror" class="tsd-kind-icon">has<wbr>Argument<wbr>Error</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_math_functions_functions_base_function_.basefunction.html#hashigherprioritythan" class="tsd-kind-icon">has<wbr>Higher<wbr>Priority<wbr>Than</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_math_functions_functions_base_function_.basefunction.html#isasyncron" class="tsd-kind-icon">is<wbr>Asyncron</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_math_functions_functions_base_function_.basefunction.html#isoperator" class="tsd-kind-icon">is<wbr>Operator</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_math_functions_functions_base_function_.basefunction.html#ispreexecutedargument" class="tsd-kind-icon">is<wbr>Preexecuted<wbr>Argument</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_math_functions_functions_base_function_.basefunction.html#isstoring" class="tsd-kind-icon">is<wbr>Storing</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_math_functions_functions_base_function_.basefunction.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-protected">
<a name="constructor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">new <wbr>Base<wbr>Function<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, priority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, operator<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, description<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, storesValues<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_math_functions_functions_base_function_.basefunction.html" class="tsd-signature-type">BaseFunction</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Base<wbr>Function<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, description<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, storesValues<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span>, isAsyncron<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_math_functions_functions_base_function_.basefunction.html" class="tsd-signature-type">BaseFunction</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:83</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a new operator-function</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Name of the function used in script. Use capital letters\ (e.g. <code>MY_FUNCTION</code>)</p>
</div>
</div>
</li>
<li>
<h5>priority: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Priority of this operation according javascript-standard. Higher value => higher priority. Operation with higher priority are called first. (<a href="https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Operators/Operator_Precedence">https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Operators/Operator_Precedence</a>)</p>
</div>
</div>
</li>
<li>
<h5>operator: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Character(s) used for this operator function\ (e.g. <code>>=</code>, <code>==</code>, <code>!=</code>).</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> description: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Description about the function</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> storesValues: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, function contains data to be hold until next call. Default is false.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_math_functions_functions_base_function_.basefunction.html" class="tsd-signature-type">BaseFunction</a></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:93</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a new function</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Name of the function used in script. Use capital letters\ (e.g. <code>MY_FUNCTION</code>)</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> description: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Description about the function</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> storesValues: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, function contains data to be hold until next call. Default is false.</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> isAsyncron: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, function must be executed asyncron. Default is false. Therefore override method <a href="_math_functions_functions_base_function_.basefunction.html#executeasync">BaseFunction.executeAsync</a>. If false, override <a href="_math_functions_functions_base_function_.basefunction.html#execute">BaseFunction.execute</a></p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_math_functions_functions_base_function_.basefunction.html" class="tsd-signature-type">BaseFunction</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="asyncron" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> asyncron</h3>
<div class="tsd-signature tsd-kind-icon">asyncron<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:77</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="description" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> description</h3>
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:58</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:9</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="operation" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> operation</h3>
<div class="tsd-signature tsd-kind-icon">operation<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:20</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="priority" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> priority</h3>
<div class="tsd-signature tsd-kind-icon">priority<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:28</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="storing" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> storing</h3>
<div class="tsd-signature tsd-kind-icon">storing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:70</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="clone" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> clone</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">clone<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_math_functions_functions_base_function_.basefunction.html" class="tsd-signature-type">BaseFunction</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#clone">clone</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:188</li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="_math_functions_functions_base_function_.basefunction.html" class="tsd-signature-type">BaseFunction</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="execute" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> execute</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">execute<span class="tsd-signature-symbol">(</span>preexecutedArguments<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span>, environment<span class="tsd-signature-symbol">: </span><a href="../interfaces/_math_functions_script_environment_.scriptenvironment.html" class="tsd-signature-type">ScriptEnvironment</a>, node<span class="tsd-signature-symbol">: </span><a href="_math_functions_nodes_node_class_.node.html" class="tsd-signature-type">Node</a>, execPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:143</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>preexecutedArguments: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>environment: <a href="../interfaces/_math_functions_script_environment_.scriptenvironment.html" class="tsd-signature-type">ScriptEnvironment</a></h5>
</li>
<li>
<h5>node: <a href="_math_functions_nodes_node_class_.node.html" class="tsd-signature-type">Node</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> execPath: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="executeasync" class="tsd-anchor"></a>
<h3>execute<wbr>Async</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">execute<wbr>Async<span class="tsd-signature-symbol">(</span>preexecutedArguments<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span>, environment<span class="tsd-signature-symbol">: </span><a href="../interfaces/_math_functions_script_environment_.scriptenvironment.html" class="tsd-signature-type">ScriptEnvironment</a>, node<span class="tsd-signature-symbol">: </span><a href="_math_functions_nodes_node_class_.node.html" class="tsd-signature-type">Node</a>, execPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:145</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>preexecutedArguments: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>environment: <a href="../interfaces/_math_functions_script_environment_.scriptenvironment.html" class="tsd-signature-type">ScriptEnvironment</a></h5>
</li>
<li>
<h5>node: <a href="_math_functions_nodes_node_class_.node.html" class="tsd-signature-type">Node</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> execPath: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="getargumenterror" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Argument<wbr>Error</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">get<wbr>Argument<wbr>Error<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_math_functions_errors_expression_error_.expressionerror.html" class="tsd-signature-type">ExpressionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:177</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the first argument with error inside args, if args is an array. Or args itself, if args is an object of ExpressionError (or derived).</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_math_functions_errors_expression_error_.expressionerror.html" class="tsd-signature-type">ExpressionError</a>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">undefined</span>
</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getdescription" class="tsd-anchor"></a>
<h3>get<wbr>Description</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Description<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#getdescription">getDescription</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:63</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the description of this function.
An empty string if a description is not available.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getname" class="tsd-anchor"></a>
<h3>get<wbr>Name</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#getname">getName</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:13</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the name of the function</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getoperator" class="tsd-anchor"></a>
<h3>get<wbr>Operator</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Operator<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#getoperator">getOperator</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:51</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the operator-character of this function.
Throws an error if this function is not useable as operation.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getpriority" class="tsd-anchor"></a>
<h3>get<wbr>Priority</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Priority<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#getpriority">getPriority</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:33</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the priority of this function.
Only needed for operators.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="hasargumenterror" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> has<wbr>Argument<wbr>Error</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">has<wbr>Argument<wbr>Error<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:164</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns true if args is an ExpressionError-object or an array which contains an ExpressionError-object.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="hashigherprioritythan" class="tsd-anchor"></a>
<h3>has<wbr>Higher<wbr>Priority<wbr>Than</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">has<wbr>Higher<wbr>Priority<wbr>Than<span class="tsd-signature-symbol">(</span>priority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#hashigherprioritythan">hasHigherPriorityThan</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:42</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns true if the priority of this function is higher than the provided priority</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>priority: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="isasyncron" class="tsd-anchor"></a>
<h3>is<wbr>Asyncron</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">is<wbr>Asyncron<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#isasyncron">isAsyncron</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:81</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns true if this function must be called asyncron and returns the value not immediately.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="isoperator" class="tsd-anchor"></a>
<h3>is<wbr>Operator</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">is<wbr>Operator<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#isoperator">isOperator</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:24</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns true if this function is also available as operation (using operator)</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="ispreexecutedargument" class="tsd-anchor"></a>
<h3>is<wbr>Preexecuted<wbr>Argument</h3>
<ul class="tsd-