cla-wrapper
Version:
Wrapper for CDISC Library API
853 lines • 46.9 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AnalysisVariableSet | cla-wrapper</title>
<meta name="description" content="Documentation for cla-wrapper">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</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.json" 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">cla-wrapper</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>
</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="../modules.html">cla-wrapper</a>
</li>
<li>
<a href="../modules/claWrapper.html">claWrapper</a>
</li>
<li>
<a href="claWrapper.AnalysisVariableSet.html">AnalysisVariableSet</a>
</li>
</ul>
<h1>Class AnalysisVariableSet</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Analysis Variable Set class. Extends ItemGroup class.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">ItemGroup</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AnalysisVariableSet</span>
</li>
</ul>
</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 ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="claWrapper.AnalysisVariableSet.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#analysisVariables" class="tsd-kind-icon">analysis<wbr>Variables</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#coreObject" class="tsd-kind-icon">core<wbr>Object</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#datasetVariables" class="tsd-kind-icon">dataset<wbr>Variables</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#fields" class="tsd-kind-icon">fields</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#href" class="tsd-kind-icon">href</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#itemType" class="tsd-kind-icon">item<wbr>Type</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#label" class="tsd-kind-icon">label</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#scenarios" class="tsd-kind-icon">scenarios</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#type" class="tsd-kind-icon">type</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 tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#findMatchingItems" class="tsd-kind-icon">find<wbr>Matching<wbr>Items</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#getFormattedItems" class="tsd-kind-icon">get<wbr>Formatted<wbr>Items</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#getItem" class="tsd-kind-icon">get<wbr>Item</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#getItems" class="tsd-kind-icon">get<wbr>Items</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#getNameList" class="tsd-kind-icon">get<wbr>Name<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#getRawResponse" class="tsd-kind-icon">get<wbr>Raw<wbr>Response</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#load" class="tsd-kind-icon">load</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#parseItemGroupResponse" class="tsd-kind-icon">parse<wbr>Item<wbr>Group<wbr>Response</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="claWrapper.AnalysisVariableSet.html#parseResponse" class="tsd-kind-icon">parse<wbr>Response</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.AnalysisVariableSet.html#toSimpleObject" class="tsd-kind-icon">to<wbr>Simple<wbr>Object</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Analysis<wbr>Variable<wbr>Set<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AnalysisVariableSetParameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="claWrapper.AnalysisVariableSet.html" class="tsd-signature-type" data-tsd-kind="Class">AnalysisVariableSet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides ItemGroup.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2322">claWrapper.ts:2322</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <span class="tsd-signature-type">AnalysisVariableSetParameters</span><span class="tsd-signature-symbol"> = {}</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="claWrapper.AnalysisVariableSet.html" class="tsd-signature-type" data-tsd-kind="Class">AnalysisVariableSet</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="analysisVariables" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> analysis<wbr>Variables</h3>
<div class="tsd-signature tsd-kind-icon">analysis<wbr>Variables<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<p>Inherited from ItemGroup.analysisVariables</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2065">claWrapper.ts:2065</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="claWrapper.Variable.html" class="tsd-signature-type" data-tsd-kind="Class">Variable</a></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="coreObject" class="tsd-anchor"></a>
<h3>core<wbr>Object</h3>
<div class="tsd-signature tsd-kind-icon">core<wbr>Object<span class="tsd-signature-symbol">:</span> <a href="claWrapper.CoreObject.html" class="tsd-signature-type" data-tsd-kind="Class">CoreObject</a></div>
<aside class="tsd-sources">
<p>Inherited from ItemGroup.coreObject</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L149">claWrapper.ts:149</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CLA Wrapper attribute. Object used to send API requests and store technical information. Must be the same object for all classes within an instance of a CdiscLibrary class.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="datasetVariables" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> dataset<wbr>Variables</h3>
<div class="tsd-signature tsd-kind-icon">dataset<wbr>Variables<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<p>Inherited from ItemGroup.datasetVariables</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2067">claWrapper.ts:2067</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="claWrapper.Variable.html" class="tsd-signature-type" data-tsd-kind="Class">Variable</a></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="fields" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> fields</h3>
<div class="tsd-signature tsd-kind-icon">fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<p>Inherited from ItemGroup.fields</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2063">claWrapper.ts:2063</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="claWrapper.Field.html" class="tsd-signature-type" data-tsd-kind="Class">Field</a></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="href" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> href</h3>
<div class="tsd-signature tsd-kind-icon">href<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from ItemGroup.href</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L147">claWrapper.ts:147</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library API endpoint.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from ItemGroup.id</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2059">claWrapper.ts:2059</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CLA Wrapper attribute. Item group class ID.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="itemType" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> item<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">item<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"fields"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"analysisVariables"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"datasetVariables"</span></div>
<aside class="tsd-sources">
<p>Inherited from ItemGroup.itemType</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2069">claWrapper.ts:2069</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CLA Wrapper attribute. Name of the item type (field, analysisVariable, datasetVariable). Corresponds to an object name of the classes which are extending ItemGroup class (Dataset, Domain, VariableSet).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="label" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> label</h3>
<div class="tsd-signature tsd-kind-icon">label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from ItemGroup.label</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2055">claWrapper.ts:2055</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</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">
<p>Inherited from ItemGroup.name</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2053">claWrapper.ts:2053</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="scenarios" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> scenarios</h3>
<div class="tsd-signature tsd-kind-icon">scenarios<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<p>Inherited from ItemGroup.scenarios</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2061">claWrapper.ts:2061</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="claWrapper.Scenario.html" class="tsd-signature-type" data-tsd-kind="Class">Scenario</a></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="type" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from ItemGroup.type</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2057">claWrapper.ts:2057</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute. Value of the _links.self.type.</p>
</div>
</div>
</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 tsd-is-inherited">
<a name="findMatchingItems" class="tsd-anchor"></a>
<h3>find<wbr>Matching<wbr>Items</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">find<wbr>Matching<wbr>Items<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MatchingOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/claWrapper.html#ItemType" class="tsd-signature-type" data-tsd-kind="Type alias">ItemType</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from ItemGroup.findMatchingItems</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2205">claWrapper.ts:2205</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Find all matching variables/fields. For example TRxxPGy matches TR01PG12.</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">
<p>Variable/Field name.</p>
</div>
</li>
<li>
<h5>options: <span class="tsd-signature-type">MatchingOptions</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../modules/claWrapper.html#ItemType" class="tsd-signature-type" data-tsd-kind="Type alias">ItemType</a><span class="tsd-signature-symbol">[]</span></h4>
<p>Array of matched items.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getFormattedItems" class="tsd-anchor"></a>
<h3>get<wbr>Formatted<wbr>Items</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Formatted<wbr>Items<span class="tsd-signature-symbol">(</span>format<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"json"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"csv"</span>, addItemGroupId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, additionalProps<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from ItemGroup.getFormattedItems</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2236">claWrapper.ts:2236</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get items in a specific format.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>format: <span class="tsd-signature-type">"json"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"csv"</span></h5>
<div class="tsd-comment tsd-typography">
<p>Specifies the output format. Possible values: json, csv.</p>
</div>
</li>
<li>
<h5>addItemGroupId: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> additionalProps: <span class="tsd-signature-type">object</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">[]</span></h4>
<p>String with formatted items or an array with item details.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getItem" class="tsd-anchor"></a>
<h3>get<wbr>Item</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Item<span class="tsd-signature-symbol">(</span>name<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><a href="../modules/claWrapper.html#ItemType" class="tsd-signature-type" data-tsd-kind="Type alias">ItemType</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from ItemGroup.getItem</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2161">claWrapper.ts:2161</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get an object with specified item name</p>
</div>
<dl class="tsd-comment-tags">
<dt>property</dt>
<dd><p>{String} name Variable/field name.</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../modules/claWrapper.html#ItemType" class="tsd-signature-type" data-tsd-kind="Type alias">ItemType</a></h4>
<p>An object with variable/field if found</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getItems" class="tsd-anchor"></a>
<h3>get<wbr>Items</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Items<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Items</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from ItemGroup.getItems</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2139">claWrapper.ts:2139</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get an object with all variables/fields for that item set. Note that for CDASHIG Scenarios have overlapping fields.
Only one field is returned by this method.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Items</span></h4>
<p>An object with variables/fields.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getNameList" class="tsd-anchor"></a>
<h3>get<wbr>Name<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Name<wbr>List<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><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from ItemGroup.getNameList</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2179">claWrapper.ts:2179</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get an array with the list of names for all items.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4>
<p>An array with item names.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getRawResponse" class="tsd-anchor"></a>
<h3>get<wbr>Raw<wbr>Response</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Raw<wbr>Response<span class="tsd-signature-symbol">(</span>href<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">object</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from ItemGroup.getRawResponse</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L162">claWrapper.ts:162</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get raw API response</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> href: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>CDISC Library API endpoint. If not specified, href attribute of the object is used.</p>
</div>
</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">object</span><span class="tsd-signature-symbol">></span></h4>
<p>Returns a JSON response if the request was successfull, otherwise returns undefined.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="load" class="tsd-anchor"></a>
<h3>load</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>href<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">boolean</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from ItemGroup.load</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L181">claWrapper.ts:181</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Load object from the CDISC Library</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> href: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>CDISC Library API endpoint. If not specified, href attribute of the object is used.</p>
</div>
</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">boolean</span><span class="tsd-signature-symbol">></span></h4>
<p>Returns true in the object was successfully loaded, false otherwise</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="parseItemGroupResponse" class="tsd-anchor"></a>
<h3>parse<wbr>Item<wbr>Group<wbr>Response</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">parse<wbr>Item<wbr>Group<wbr>Response<span class="tsd-signature-symbol">(</span>itemRaw<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-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from ItemGroup.parseItemGroupResponse</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2095">claWrapper.ts:2095</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Parse API response to variable set.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>itemRaw: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>CDISC API response.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="parseResponse" class="tsd-anchor"></a>
<h3>parse<wbr>Response</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">parse<wbr>Response<span class="tsd-signature-symbol">(</span>raw<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-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides ItemGroup.parseResponse</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2332">claWrapper.ts:2332</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Parse API response to variable set</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>raw: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Raw CDISC API response</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="toSimpleObject" class="tsd-anchor"></a>
<h3>to<wbr>Simple<wbr>Object</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>Simple<wbr>Object<span class="tsd-signature-symbol">(</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">
<p>Inherited from ItemGroup.toSimpleObject</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L196">claWrapper.ts:196</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Convert class to a simple object, removes methods and technical elements (e.g., coreObject).</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
<p>A new object</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/claWrapper.html">cla<wbr>Wrapper</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/searchResponse.html">search<wbr>Response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.AnalysisVariableSet.html" class="tsd-kind-icon">Analysis<wbr>Variable<wbr>Set</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="claWrapper.AnalysisVariableSet.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#analysisVariables" class="tsd-kind-icon">analysis<wbr>Variables</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#coreObject" class="tsd-kind-icon">core<wbr>Object</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#datasetVariables" class="tsd-kind-icon">dataset<wbr>Variables</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#fields" class="tsd-kind-icon">fields</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#href" class="tsd-kind-icon">href</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#itemType" class="tsd-kind-icon">item<wbr>Type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#label" class="tsd-kind-icon">label</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#scenarios" class="tsd-kind-icon">scenarios</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#findMatchingItems" class="tsd-kind-icon">find<wbr>Matching<wbr>Items</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#getFormattedItems" class="tsd-kind-icon">get<wbr>Formatted<wbr>Items</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#getItem" class="tsd-kind-icon">get<wbr>Item</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#getItems" class="tsd-kind-icon">get<wbr>Items</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#getNameList" class="tsd-kind-icon">get<wbr>Name<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#getRawResponse" class="tsd-kind-icon">get<wbr>Raw<wbr>Response</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#load" class="tsd-kind-icon">load</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#parseItemGroupResponse" class="tsd-kind-icon">parse<wbr>Item<wbr>Group<wbr>Response</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="claWrapper.AnalysisVariableSet.html#parseResponse" class="tsd-kind-icon">parse<wbr>Response</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.AnalysisVariableSet.html#toSimpleObject" class="tsd-kind-icon">to<wbr>Simple<wbr>Object</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.CdiscLibrary.html" class="tsd-kind-icon">Cdisc<wbr>Library</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.CodeList.html" class="tsd-kind-icon">Code<wbr>List</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.CoreObject.html" class="tsd-kind-icon">Core<wbr>Object</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.DataClass.html" class="tsd-kind-icon">Data<wbr>Class</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.DataStructure.html" class="tsd-kind-icon">Data<wbr>Structure</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.Dataset.html" class="tsd-kind-icon">Dataset</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.Domain.html" class="tsd-kind-icon">Domain</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.Field.html" class="tsd-kind-icon">Field</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.Product.html" class="tsd-kind-icon">Product</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.ProductClass.html" class="tsd-kind-icon">Product<wbr>Class</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.ProductGroup.html" class="tsd-kind-icon">Product<wbr>Group</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.Scenario.html" class="tsd-kind-icon">Scenario</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.Variable.html" class="tsd-kind-icon">Variable</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/claWrapper.html#ItemType" class="tsd-kind-icon">Item<wbr>Type</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>