docs/module-._excel.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: fin-hypergrid-excel</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>
<table style="width: 100%">
    <tr>
        <td style="vertical-align: top;">
            <nav>
                <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-._cell-provider.html">.\cell-provider</a></li><li><a href="module-._data.html">.\data</a></li><li><a href="module-._excel.html">.\excel</a></li><li><a href="module-._fin-hypergrid.html">.\fin-hypergrid</a></li><li><a href="module-._renderer.html">.\renderer</a></li><li><a href="module-._selection-model.html">.\selection-model</a></li><li><a href="module-behaviors_base.html">behaviors\base</a></li><li><a href="module-behaviors_default.html">behaviors\default</a></li><li><a href="module-behaviors_gol.html">behaviors\gol</a></li><li><a href="module-behaviors_in-memory.html">behaviors\in-memory</a></li><li><a href="module-behaviors_json.html">behaviors\json</a></li><li><a href="module-behaviors_q.html">behaviors\q</a></li><li><a href="module-behaviors_qtree.html">behaviors\qtree</a></li><li><a href="module-behaviors_web-worker.html">behaviors\web-worker</a></li><li><a href="module-cell-editors_base.html">cell-editors\base</a></li><li><a href="module-cell-editors_choice.html">cell-editors\choice</a></li><li><a href="module-cell-editors_color.html">cell-editors\color</a></li><li><a href="module-cell-editors_date.html">cell-editors\date</a></li><li><a href="module-cell-editors_simple.html">cell-editors\simple</a></li><li><a href="module-cell-editors_slider.html">cell-editors\slider</a></li><li><a href="module-cell-editors_spinner.html">cell-editors\spinner</a></li><li><a href="module-cell-editors_textfield.html">cell-editors\textfield</a></li><li><a href="module-features_base.html">features\base</a></li><li><a href="module-features_cell-click.html">features\cell-click</a></li><li><a href="module-features_cell-editing.html">features\cell-editing</a></li><li><a href="module-features_cell-selection.html">features\cell-selection</a></li><li><a href="module-features_column-autosizing.html">features\column-autosizing</a></li><li><a href="module-features_column-moving.html">features\column-moving</a></li><li><a href="module-features_column-resizing.html">features\column-resizing</a></li><li><a href="module-features_column-sorting.html">features\column-sorting</a></li><li><a href="module-features_key-paging.html">features\key-paging</a></li><li><a href="module-features_on-hover.html">features\on-hover</a></li><li><a href="module-features_overlay.html">features\overlay</a></li><li><a href="module-features_row-resizing.html">features\row-resizing</a></li><li><a href="module-features_thumbwheel-scrolling.html">features\thumbwheel-scrolling</a></li></ul><h3>Global</h3><ul><li><a href="global.html#checkDragScroll">checkDragScroll</a></li><li><a href="global.html#createdInit">createdInit</a></li><li><a href="global.html#currentDrag">currentDrag</a></li><li><a href="global.html#extendSelection">extendSelection</a></li><li><a href="global.html#getAutoScrollAcceleration">getAutoScrollAcceleration</a></li><li><a href="global.html#getAutoScrollDuration">getAutoScrollDuration</a></li><li><a href="global.html#handleDOWN">handleDOWN</a></li><li><a href="global.html#handleDOWNSHIFT">handleDOWNSHIFT</a></li><li><a href="global.html#handleKeyDown">handleKeyDown</a></li><li><a href="global.html#handleLEFT">handleLEFT</a></li><li><a href="global.html#handleLEFTSHIFT">handleLEFTSHIFT</a></li><li><a href="global.html#handleMouseDown">handleMouseDown</a></li><li><a href="global.html#handleMouseDrag">handleMouseDrag</a></li><li><a href="global.html#handleMouseDragCellSelection">handleMouseDragCellSelection</a></li><li><a href="global.html#handleMouseUp">handleMouseUp</a></li><li><a href="global.html#handleRIGHT">handleRIGHT</a></li><li><a href="global.html#handleRIGHTSHIFT">handleRIGHTSHIFT</a></li><li><a href="global.html#handleUP">handleUP</a></li><li><a href="global.html#handleUPSHIFT">handleUPSHIFT</a></li><li><a href="global.html#lastDragCell">lastDragCell</a></li><li><a href="global.html#moveShiftSelect">moveShiftSelect</a></li><li><a href="global.html#moveSingleSelect">moveSingleSelect</a></li><li><a href="global.html#pingAutoScroll">pingAutoScroll</a></li><li><a href="global.html#rectangles">rectangles</a></li><li><a href="global.html#sbAutoStart">sbAutoStart</a></li><li><a href="global.html#sbLastAuto">sbLastAuto</a></li><li><a href="global.html#scrollDrag">scrollDrag</a></li><li><a href="global.html#setAutoScrollStartTime">setAutoScrollStartTime</a></li></ul>
            </nav>
        </td>
        <td style="vertical-align: top;">
            <div id="main">

                <h1 class="page-title">fin-hypergrid-excel</h1>

                
<section>

<header>
    
        
</header>

<article>
    <div class="container-overview">
    
        
            <div class="description"><h5>fin-hypergrid-excel is is a plugin for hypergrid that provides integration with excel.</h5></div>
        

<dl class="details">

    
</dl>


    </div>

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

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


    <h5 class="subsection-title">Properties:</h5>

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

        <th>Type</th>

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

    <tbody>
    

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

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


            </td>

            
            <td class="description last"><p>the <a href="module-._fin-hypergrid.html">fin-hypergrid</a> I'm installed into</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


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


    <h5 class="subsection-title">Properties:</h5>

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

        <th>Type</th>

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

    <tbody>
    

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

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


            </td>

            
            <td class="description last"><p>default configuration values</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


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


    <h5 class="subsection-title">Properties:</h5>

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

        <th>Type</th>

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

    <tbody>
    

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

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


            </td>

            
            <td class="description last"><p>am I currently running (polling for changes to push to excel)</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


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

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

    
<div class="description">
    <p>create a blob appropriate to send to excel</p>
<h4>returns: Object</h4>
</div>


<dl class="details">

    
</dl>


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

    
<div class="description">
    <p>handle any errors excel might publish to the bus</p>
</div>


<dl class="details">

    
</dl>


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

    
<div class="description">
    <p>this is called as the hook for the nested tag plugin pattern. this is how this excel component is installed into the hypergrid</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>grid</code></td>
            

            <td class="type">
            
                
<span class="param-type">fin-hypergrid</span>


            </td>

            
            <td class="description last"><p>see <a href="module-._fin-hypergrid.html">fin-hypergrid</a></p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


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

    
<div class="description">
    <p>create and send a blob of the current selection to excel</p>
</div>


<dl class="details">

    
</dl>


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

    
<div class="description">
    <p>start polling for pushes to excel</p>
</div>


<dl class="details">

    
</dl>


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

    
<div class="description">
    <p>stop polling for pushes to excel</p>
</div>


<dl class="details">

    
</dl>


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

    
<div class="description">
    <p>subscribe to excel</p>
</div>


<dl class="details">

    
</dl>


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

    
<div class="description">
    <p>handle the data that comes from excel</p>
</div>


<dl class="details">

    
</dl>


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

    
<div class="description">
    <p>unsubscribe to excel</p>
</div>


<dl class="details">

    
</dl>


</article>

</section>


            </div>
        </td>
    </tr>
</table>


<br class="clear">

<footer>
    © 2015 <a href="http://www.openfin.co" target="_blank">OpenFin</a> All Rights Reserved.
</footer>

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