build/jsdoc/ShapeController.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: ShapeController</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Class: ShapeController</h1>

    
<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>ShapeController<span class="signature">(uiState, container, decompViewDict)</span><span class="type-signature"> &rarr; {<a href="ShapeController.html">ShapeController</a>}</span></h2>
        
            <div class="class-description"><p>ShapeController</p>
<p>Manipulates and displays the shape of objects on screen.</p></div>
        
    
</header>

<article>
    <div class="container-overview">
    
        
    <h2>Constructor</h2>
    

    <h4 class="name" id="ShapeController"><span class="type-signature"></span>new ShapeController<span class="signature">(uiState, container, decompViewDict)</span><span class="type-signature"> &rarr; {<a href="ShapeController.html">ShapeController</a>}</span></h4>
    

    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>uiState</code></td>
            

            <td class="type">
            
                
<span class="param-type">UIState</span>


            </td>

            
            <td class="description last"><p>The shared state</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>container</code></td>
            

            <td class="type">
            
                
<span class="param-type">Node</span>


            </td>

            
            <td class="description last"><p>Container node to create the controller in.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>decompViewDict</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>This is object is keyed by unique
identifiers and the values are DecompositionView objects referring to a
set of objects presented on screen. This dictionary will usually be shared
by all the tabs in the application. This argument is passed by reference.
Note that only the decompositions of type 'scatter' will be controlled,
other types will be ignored.</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="shape-controller.js.html">shape-controller.js</a>, <a href="shape-controller.js.html#line31">line 31</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    <p>An instance of ShapeController</p>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="ShapeController.html">ShapeController</a></span>


    </dd>
</dl>

    
    </div>

    
        <h3 class="subsection-title">Extends</h3>

        
    <ul>
        <li><a href="EmperorAttributeABC.html">EmperorAttributeABC</a></li>
    </ul>


        <h3 class="subsection-title">Members</h3>

        
<h4 class="name" id="$body"><span class="type-signature"></span>$body<span class="type-signature"> :Node</span></h4>


<div class="description">
    <p>jQuery element for the body, which contains the lowermost elementsdisplayed in tab. This goes below the header.</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Node</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorViewControllerABC.html#$body">EmperorViewControllerABC#$body</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abc-view-controller.js.html">abc-view-controller.js</a>, <a href="abc-view-controller.js.html#line60">line 60</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="$canvas"><span class="type-signature"></span>$canvas<span class="type-signature"> :Node</span></h4>


<div class="description">
    <p>jQuery element for the canvas, which contains the header and the body.</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Node</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorViewControllerABC.html#$canvas">EmperorViewControllerABC#$canvas</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abc-view-controller.js.html">abc-view-controller.js</a>, <a href="abc-view-controller.js.html#line54">line 54</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="$container"><span class="type-signature"></span>$container<span class="type-signature"> :Node</span></h4>


<div class="description">
    <p>jQuery element for the parent container.</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Node</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorViewControllerABC.html#$container">EmperorViewControllerABC#$container</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abc-view-controller.js.html">abc-view-controller.js</a>, <a href="abc-view-controller.js.html#line38">line 38</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="$gridDiv"><span class="type-signature"></span>$gridDiv<span class="type-signature"> :Node</span></h4>


<div class="description">
    <p>jQuery element for the div containing the slickgrid of sample information</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Node</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorAttributeABC.html#$gridDiv">EmperorAttributeABC#$gridDiv</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="view-controller.js.html">view-controller.js</a>, <a href="view-controller.js.html#line164">line 164</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="$header"><span class="type-signature"></span>$header<span class="type-signature"> :Node</span></h4>


<div class="description">
    <p>jQuery element for the header which contains the uppermost elementsdisplayed in a tab.</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Node</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorViewControllerABC.html#$header">EmperorViewControllerABC#$header</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abc-view-controller.js.html">abc-view-controller.js</a>, <a href="abc-view-controller.js.html#line66">line 66</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="active"><span class="type-signature"></span>active<span class="type-signature"> :Boolean</span></h4>


<div class="description">
    <p>Indicates whether the tab is front most</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorViewControllerABC.html#active">EmperorViewControllerABC#active</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>false</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abc-view-controller.js.html">abc-view-controller.js</a>, <a href="abc-view-controller.js.html#line72">line 72</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="bodyGrid"><span class="type-signature"></span>bodyGrid<span class="type-signature"> :Slick.Grid</span></h4>


<div class="description">
    <p>Container that lists the metadata categories described under themetadata column and the attribute that can be modified.</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Slick.Grid</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorAttributeABC.html#bodyGrid">EmperorAttributeABC#bodyGrid</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="view-controller.js.html">view-controller.js</a>, <a href="view-controller.js.html#line392">line 392</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="decompViewDict"><span class="type-signature"></span>decompViewDict<span class="type-signature"> :Object</span></h4>


<div class="description">
    <p>This is object is keyed by unique identifiers and the values areDecompositionView objects referring to a set of objects presented onscreen. This dictionary will usually be shared by all the tabs in theapplication. This argument is passed by reference.</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorViewController.html#decompViewDict">EmperorViewController#decompViewDict</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="view-controller.js.html">view-controller.js</a>, <a href="view-controller.js.html#line60">line 60</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="description"><span class="type-signature"></span>description<span class="type-signature"> :String</span></h4>


<div class="description">
    <p>Human-readable description of the tab.</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorViewControllerABC.html#description">EmperorViewControllerABC#description</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abc-view-controller.js.html">abc-view-controller.js</a>, <a href="abc-view-controller.js.html#line48">line 48</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="enabled"><span class="type-signature"></span>enabled<span class="type-signature"> :Boolean</span></h4>


<div class="description">
    <p>Indicates if tab can be accessed.</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorViewControllerABC.html#enabled">EmperorViewControllerABC#enabled</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>true</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abc-view-controller.js.html">abc-view-controller.js</a>, <a href="abc-view-controller.js.html#line84">line 84</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="identifier"><span class="type-signature"></span>identifier<span class="type-signature"> :String</span></h4>


<div class="description">
    <p>Unique hash identifier for the tab instance.</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorViewControllerABC.html#identifier">EmperorViewControllerABC#identifier</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>"EMPtab-xxxxxxx"</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abc-view-controller.js.html">abc-view-controller.js</a>, <a href="abc-view-controller.js.html#line78">line 78</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="ready"><span class="type-signature"></span>ready<span class="type-signature"> :function</span></h4>


<div class="description">
    <p>Callback to execute when all the elements in the UI for this controllerhave been loaded. Note, that this functionality needs to be implementedby subclasses, as EmperorViewController does not have any UI components.</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">function</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorViewController.html#ready">EmperorViewController#ready</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="view-controller.js.html">view-controller.js</a>, <a href="view-controller.js.html#line68">line 68</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="title"><span class="type-signature"></span>title<span class="type-signature"> :String</span></h4>


<div class="description">
    <p>Human-readable title of the tab.</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorViewControllerABC.html#title">EmperorViewControllerABC#title</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abc-view-controller.js.html">abc-view-controller.js</a>, <a href="abc-view-controller.js.html#line43">line 43</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="UIState"><span class="type-signature"></span>UIState<span class="type-signature"> :UIState</span></h4>


<div class="description">
    <p>The shared state</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">UIState</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorViewControllerABC.html#UIState">EmperorViewControllerABC#UIState</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abc-view-controller.js.html">abc-view-controller.js</a>, <a href="abc-view-controller.js.html#line32">line 32</a>
    </li></ul></dd>
    

</dl>


        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id="decompositionName"><span class="type-signature"></span>decompositionName<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Get the name of the decomposition selected in the metadata menu.</p>
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorAttributeABC.html#decompositionName">EmperorAttributeABC#decompositionName</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="view-controller.js.html">view-controller.js</a>, <a href="view-controller.js.html#line255">line 255</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="forceRefresh"><span class="type-signature"></span>forceRefresh<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Writes the current settings to the active decomposition view(s).
Will be called when the decomposition view is swapped out
for a different view type.</p>
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorViewControllerABC.html#forceRefresh">EmperorViewControllerABC#forceRefresh</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abc-view-controller.js.html">abc-view-controller.js</a>, <a href="abc-view-controller.js.html#line204">line 204</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="fromJSON"><span class="type-signature"></span>fromJSON<span class="signature">(json)</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Decodes JSON string and modifies its own instance variables accordingly.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>json</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>Parsed JSON string representation of self.</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorAttributeABC.html#fromJSON">EmperorAttributeABC#fromJSON</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="view-controller.js.html">view-controller.js</a>, <a href="view-controller.js.html#line523">line 523</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="getMetadataField"><span class="type-signature"></span>getMetadataField<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Get the name of the selected category in the metadata menu.</p>
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorAttributeABC.html#getMetadataField">EmperorAttributeABC#getMetadataField</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="view-controller.js.html">view-controller.js</a>, <a href="view-controller.js.html#line328">line 328</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="getSlickGridDataset"><span class="type-signature"></span>getSlickGridDataset<span class="signature">()</span><span class="type-signature"> &rarr; {Array}</span></h4>
    

<div class="description">
    <p>Retrieves the underlying data in the slick grid</p>
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorAttributeABC.html#getSlickGridDataset">EmperorAttributeABC#getSlickGridDataset</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="view-controller.js.html">view-controller.js</a>, <a href="view-controller.js.html#line337">line 337</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    <p>Returns an array of objects
displayed by the body grid.</p>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array</span>


    </dd>
</dl>

    
    <h4 class="name" id="getView"><span class="type-signature"></span>getView<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Get the view that's currently selected by the metadata menu.</p>
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorAttributeABC.html#getView">EmperorAttributeABC#getView</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="view-controller.js.html">view-controller.js</a>, <a href="view-controller.js.html#line264">line 264</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="hasMetadataField"><span class="type-signature"></span>hasMetadataField<span class="signature">(m)</span><span class="type-signature"> &rarr; {Bool}</span></h4>
    

<div class="description">
    <p>Check if a metadata field is present</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>m</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>Metadata column to check if is present.</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorViewController.html#hasMetadataField">EmperorViewController#hasMetadataField</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="view-controller.js.html">view-controller.js</a>, <a href="view-controller.js.html#line97">line 97</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    <p>Whether or not the metadata field is present.</p>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Bool</span>


    </dd>
</dl>

    
    <h4 class="name" id="refreshMetadata"><span class="type-signature"></span>refreshMetadata<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Update the metadata selection menu.</p>
<p>Performs some additional logic to avoid duplicating decomposition names.</p>
<p>Note that decompositions won't be updated if they have the same name and
same metadata headers, if the only things changing are coordinates, or
metadata values, the changes should be performed directly on the objects
themselves.</p>
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorAttributeABC.html#refreshMetadata">EmperorAttributeABC#refreshMetadata</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="view-controller.js.html">view-controller.js</a>, <a href="view-controller.js.html#line549">line 549</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="resize"><span class="type-signature"></span>resize<span class="signature">(width, height)</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Resizes the container and the individual elements.</p>
<p>Note, the consumer of this class, likely the main controller should call
the resize function any time a resizing event happens.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">Float</span>


            </td>

            
            <td class="description last"><p>the container width.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">Float</span>


            </td>

            
            <td class="description last"><p>the container height.</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorAttributeABC.html#resize">EmperorAttributeABC#resize</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="view-controller.js.html">view-controller.js</a>, <a href="view-controller.js.html#line483">line 483</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="setActive"><span class="type-signature"></span>setActive<span class="signature">(trulse)</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Sets whether or not the tab is visible.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>trulse</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
            <td class="description last"><p>option to activate tab
(i.e. move tab to foreground).</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorViewControllerABC.html#setActive">EmperorViewControllerABC#setActive</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abc-view-controller.js.html">abc-view-controller.js</a>, <a href="abc-view-controller.js.html#line146">line 146</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="setEnabled"><span class="type-signature"></span>setEnabled<span class="signature">(trulse)</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Sets whether or not the tab can be modified or accessed.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>trulse</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
            <td class="description last"><p>option to enable tab.</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorAttributeABC.html#setEnabled">EmperorAttributeABC#setEnabled</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="view-controller.js.html">view-controller.js</a>, <a href="view-controller.js.html#line589">line 589</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="setMetadataField"><span class="type-signature"></span>setMetadataField<span class="signature">(m)</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Changes the selected value in the metadata menu.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>m</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>Metadata column name to control. When the category is
<code>null</code>, the metadata selector is set to an empty value, the body grid
is emptied, and all the markers are reset to a default state (depends on
the subclass).</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorAttributeABC.html#setMetadataField">EmperorAttributeABC#setMetadataField</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="view-controller.js.html">view-controller.js</a>, <a href="view-controller.js.html#line300">line 300</a>
    </li></ul></dd>
    

</dl>


<h5>Throws:</h5>

        
<dl>
    <dt>
        <div class="param-desc">
        <p>Argument <code>m</code> must be a metadata category in one of the
decomposition views.</p>
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>
                
<span class="param-type">Error</span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


    <h4 class="name" id="setPlottableAttributes"><span class="type-signature"></span>setPlottableAttributes<span class="signature">(scope, shape, group)</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Helper function to set the shape of plottable</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>scope</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>The scope where the plottables exist</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>shape</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>String representation of the shape to be applied
to the plottables.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>group</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Object></span>


            </td>

            
            <td class="description last"><p>Array of objects that should be changed in scope</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="shape-controller.js.html">shape-controller.js</a>, <a href="shape-controller.js.html#line117">line 117</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="setSlickGridDataset"><span class="type-signature"></span>setSlickGridDataset<span class="signature">(data)</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Changes the underlying data in the slick grid</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>data</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            </td>

            
            <td class="description last"><p>data.</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorAttributeABC.html#setSlickGridDataset">EmperorAttributeABC#setSlickGridDataset</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="view-controller.js.html">view-controller.js</a>, <a href="view-controller.js.html#line346">line 346</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="toJSON"><span class="type-signature"></span>toJSON<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    <p>Converts the current instance into a JSON object.</p>
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EmperorAttributeABC.html#toJSON">EmperorAttributeABC#toJSON</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="view-controller.js.html">view-controller.js</a>, <a href="view-controller.js.html#line503">line 503</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    <p>base object ready for JSON conversion.</p>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-draw.html">draw</a></li><li><a href="module-SlickGridColors.html">SlickGridColors</a></li><li><a href="module-SlickGridScale.html">SlickGridScale</a></li><li><a href="module-SlickGridShapes.html">SlickGridShapes</a></li><li><a href="module-trajectory.html">trajectory</a></li><li><a href="module-utility-functions.html">utility-functions</a></li></ul><h3>Classes</h3><ul><li><a href="AnimationDirector.html">AnimationDirector</a></li><li><a href="AnimationsController.html">AnimationsController</a></li><li><a href="AxesController.html">AxesController</a></li><li><a href="ColorViewController.html">ColorViewController</a></li><li><a href="DecompositionModel.html">DecompositionModel</a></li><li><a href="DecompositionView.html">DecompositionView</a></li><li><a href="EmperorAttributeABC.html">EmperorAttributeABC</a></li><li><a href="EmperorController.html">EmperorController</a></li><li><a href="EmperorViewController.html">EmperorViewController</a></li><li><a href="EmperorViewControllerABC.html">EmperorViewControllerABC</a></li><li><a href="module-draw-THREE.EmperorTrajectory.html">EmperorTrajectory</a></li><li><a href="module-SlickGridColors.ColorEditor.html">ColorEditor</a></li><li><a href="module-SlickGridScale.ScaleEditor.html">ScaleEditor</a></li><li><a href="module-SlickGridShapes.ShapeEditor.html">ShapeEditor</a></li><li><a href="OpacityViewController.html">OpacityViewController</a></li><li><a href="Plottable.html">Plottable</a></li><li><a href="ScalarViewControllerABC.html">ScalarViewControllerABC</a></li><li><a href="ScaleViewController.html">ScaleViewController</a></li><li><a href="ScenePlotView3D.html">ScenePlotView3D</a></li><li><a href="ShapeController.html">ShapeController</a></li><li><a href="TrajectoryOfSamples.html">TrajectoryOfSamples</a></li><li><a href="VisibilityController.html">VisibilityController</a></li></ul><h3>Global</h3><ul><li><a href="global.html#getGeometry">getGeometry</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Jul 21 2020 10:58:02 GMT-0700 (Pacific Daylight Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>