/build/master/Khill/Lavacharts/Dashboards/ChartWrapper.html
HTML | 342 lines | 279 code | 63 blank | 0 comment | 0 complexity | b47ecb091a5b790a328300053d8d0029 MD5 | raw file
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="UTF-8" />
- <meta name="robots" content="index, follow, all" />
- <title>Khill\Lavacharts\Dashboards\ChartWrapper | Lavacharts API</title>
- <link rel="stylesheet" type="text/css" href="../../../css/bootstrap.min.css">
- <link rel="stylesheet" type="text/css" href="../../../css/bootstrap-theme.min.css">
- <link rel="stylesheet" type="text/css" href="../../../css/sami.css">
- <script src="../../../js/jquery-1.11.1.min.js"></script>
- <script src="../../../js/bootstrap.min.js"></script>
- <script src="../../../js/typeahead.min.js"></script>
- <script src="../../../sami.js"></script>
- <meta name="MobileOptimized" content="width">
- <meta name="HandheldFriendly" content="true">
- <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
-
- <link rel="icon" href="../../../images/favicon.ico" type="image/x-icon">
-
- </head>
- <body id="class" data-name="class:Khill_Lavacharts_Dashboards_ChartWrapper" data-root-path="../../../">
- <div id="content">
- <div id="left-column">
- <div id="control-panel">
- <form id="search-form" action="../../../search.html" method="GET">
- <span class="glyphicon glyphicon-search"></span>
- <input name="search"
- class="typeahead form-control"
- type="search"
- placeholder="Search">
- </form>
- </div>
- <div id="api-tree"></div>
- </div>
- <div id="right-column">
- <nav id="site-nav" class="navbar navbar-default" role="navigation">
- <div class="container-fluid">
- <div class="navbar-header">
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
- <a class="navbar-brand" href="../../../index.html">
- <img src="../../../images/lava-logo.gif" />
- </a>
- </div>
- <div class="collapse navbar-collapse" id="navbar-elements">
- <ul class="nav navbar-nav">
- <li><a href="../../../classes.html">Classes</a></li>
- <li><a href="../../../namespaces.html">Namespaces</a></li>
- <li><a href="../../../interfaces.html">Interfaces</a></li>
- <li><a href="../../../traits.html">Traits</a></li>
- <li><a href="../../../doc-index.html">Index</a></li>
- <li><a href="../../../search.html">Search</a></li>
- </ul>
- </div>
- </div>
- </nav>
- <div class="namespace-breadcrumbs">
- <ol class="breadcrumb">
- <li><span class="label label-default">class</span></li>
- <li><a href="../../../Khill.html">Khill</a></li>
- <li><a href="../../../Khill/Lavacharts.html">Lavacharts</a></li>
- <li><a href="../../../Khill/Lavacharts/Dashboards.html">Dashboards</a></li>
-
- <li>ChartWrapper</li>
- </ol>
- </div>
- <div id="page-content">
-
- <div class="page-header">
- <h1>ChartWrapper</h1>
- </div>
- <p> class
- <strong>ChartWrapper</strong> extends <a href="../../../Khill/Lavacharts/Dashboards/Wrapper.html"><abbr title="Khill\Lavacharts\Dashboards\Wrapper">Wrapper</abbr></a> (<a href="https://github.com/khill/lavacharts/blob/master/src/Dashboards/ChartWrapper.php">View source</a>)
- </p>
- <div class="description">
- <p>ChartWrapper Class</p> <p>Used for wrapping charts to use in dashboards.</p> </div>
-
-
- <h2>Constants</h2>
- <table class="table table-condensed">
- <tr>
- <td>VIZ_CLASS</td>
- <td class="last">
- <p><em>Javascript chart class.</em></p>
- <p>
- </p>
- </td>
- </tr>
- </table>
-
-
- <h2>Methods</h2>
- <div class="container-fluid underlined">
- <div class="row">
- <div class="col-md-2 type">
-
-
- </div>
- <div class="col-md-8 type">
- <a href="#method___construct">__construct</a>(
- <abbr title="Khill\Lavacharts\Dashboards\Khill\Lavacharts\Charts\Chart">Chart</abbr> $chart,
- <abbr title="Khill\Lavacharts\Dashboards\Khill\Lavacharts\Values\ElementId">ElementId</abbr> $containerId)
- <p>Builds a ChartWrapper object.</p> </div>
- <div class="col-md-2"></div>
- </div>
- <div class="row">
- <div class="col-md-2 type">
-
- <a href="../../../Khill/Lavacharts/Values/ElementId.html"><abbr title="Khill\Lavacharts\Values\ElementId">ElementId</abbr></a>
- </div>
- <div class="col-md-8 type">
- <a href="#method_getContainerId">getContainerId</a>()
- <p>Returns the container id.</p> </div>
- <div class="col-md-2"><small>from
- <a href="../../../Khill/Lavacharts/Dashboards/Wrapper.html#method_getContainerId"><abbr title="Khill\Lavacharts\Dashboards\Wrapper">Wrapper</abbr></a></small></div>
- </div>
- <div class="row">
- <div class="col-md-2 type">
-
- <a href="../../../Khill/Lavacharts/Charts/Chart.html"><abbr title="Khill\Lavacharts\Charts\Chart">Chart</abbr></a>|<a href="../../../Khill/Lavacharts/Dashboards/Filters/Filter.html"><abbr title="Khill\Lavacharts\Dashboards\Filters\Filter">Filter</abbr></a>
- </div>
- <div class="col-md-8 type">
- <a href="#method_unwrap">unwrap</a>()
- <p>Unwraps and returns the wrapped object.</p> </div>
- <div class="col-md-2"><small>from
- <a href="../../../Khill/Lavacharts/Dashboards/Wrapper.html#method_unwrap"><abbr title="Khill\Lavacharts\Dashboards\Wrapper">Wrapper</abbr></a></small></div>
- </div>
- <div class="row">
- <div class="col-md-2 type">
-
- array
- </div>
- <div class="col-md-8 type">
- <a href="#method_jsonSerialize">jsonSerialize</a>()
- <p>Custom serialization of the ChartWrapper.</p> </div>
- <div class="col-md-2"><small>from
- <a href="../../../Khill/Lavacharts/Dashboards/Wrapper.html#method_jsonSerialize"><abbr title="Khill\Lavacharts\Dashboards\Wrapper">Wrapper</abbr></a></small></div>
- </div>
- <div class="row">
- <div class="col-md-2 type">
-
- string
- </div>
- <div class="col-md-8 type">
- <a href="#method_toJavascript">toJavascript</a>()
- <p>Returns a javascript string with the constructor for the Wrapper.</p> </div>
- <div class="col-md-2"><small>from
- <a href="../../../Khill/Lavacharts/Dashboards/Wrapper.html#method_toJavascript"><abbr title="Khill\Lavacharts\Dashboards\Wrapper">Wrapper</abbr></a></small></div>
- </div>
- </div>
- <h2>Details</h2>
- <div id="method-details">
- <div class="method-item">
- <h3 id="method___construct">
- <div class="location">at line 37</div>
- <code>
-
- <strong>__construct</strong>(
- <abbr title="Khill\Lavacharts\Dashboards\Khill\Lavacharts\Charts\Chart">Chart</abbr> $chart,
- <abbr title="Khill\Lavacharts\Dashboards\Khill\Lavacharts\Values\ElementId">ElementId</abbr> $containerId)</code>
- </h3>
- <div class="details">
- <div class="method-description">
- <p>Builds a ChartWrapper object.</p> </div>
- <div class="tags">
- <h4>Parameters</h4>
- <table class="table table-condensed">
- <tr>
- <td>
- <abbr title="Khill\Lavacharts\Dashboards\Khill\Lavacharts\Charts\Chart">Chart</abbr></td>
- <td>$chart</td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <abbr title="Khill\Lavacharts\Dashboards\Khill\Lavacharts\Values\ElementId">ElementId</abbr></td>
- <td>$containerId</td>
- <td>
- </td>
- </tr>
- </table>
-
-
-
- </div>
- </div>
- </div>
- <div class="method-item">
- <h3 id="method_getContainerId">
- <div class="location">in
- <a href="../../../Khill/Lavacharts/Dashboards/Wrapper.html#method_getContainerId"><abbr title="Khill\Lavacharts\Dashboards\Wrapper">Wrapper</abbr></a> at line 55</div>
- <code>
- <a href="../../../Khill/Lavacharts/Values/ElementId.html"><abbr title="Khill\Lavacharts\Values\ElementId">ElementId</abbr></a>
- <strong>getContainerId</strong>()</code>
- </h3>
- <div class="details">
- <div class="method-description">
- <p>Returns the container id.</p> </div>
- <div class="tags">
-
- <h4>Return Value</h4>
- <table class="table table-condensed">
- <tr>
- <td>
- <a href="../../../Khill/Lavacharts/Values/ElementId.html"><abbr title="Khill\Lavacharts\Values\ElementId">ElementId</abbr></a></td>
- <td>
- </td>
- </tr>
- </table>
-
-
- </div>
- </div>
- </div>
- <div class="method-item">
- <h3 id="method_unwrap">
- <div class="location">in
- <a href="../../../Khill/Lavacharts/Dashboards/Wrapper.html#method_unwrap"><abbr title="Khill\Lavacharts\Dashboards\Wrapper">Wrapper</abbr></a> at line 65</div>
- <code>
- <a href="../../../Khill/Lavacharts/Charts/Chart.html"><abbr title="Khill\Lavacharts\Charts\Chart">Chart</abbr></a>|<a href="../../../Khill/Lavacharts/Dashboards/Filters/Filter.html"><abbr title="Khill\Lavacharts\Dashboards\Filters\Filter">Filter</abbr></a>
- <strong>unwrap</strong>()</code>
- </h3>
- <div class="details">
- <div class="method-description">
- <p>Unwraps and returns the wrapped object.</p> </div>
- <div class="tags">
-
- <h4>Return Value</h4>
- <table class="table table-condensed">
- <tr>
- <td>
- <a href="../../../Khill/Lavacharts/Charts/Chart.html"><abbr title="Khill\Lavacharts\Charts\Chart">Chart</abbr></a>|<a href="../../../Khill/Lavacharts/Dashboards/Filters/Filter.html"><abbr title="Khill\Lavacharts\Dashboards\Filters\Filter">Filter</abbr></a></td>
- <td>
- </td>
- </tr>
- </table>
-
-
- </div>
- </div>
- </div>
- <div class="method-item">
- <h3 id="method_jsonSerialize">
- <div class="location">in
- <a href="../../../Khill/Lavacharts/Dashboards/Wrapper.html#method_jsonSerialize"><abbr title="Khill\Lavacharts\Dashboards\Wrapper">Wrapper</abbr></a> at line 75</div>
- <code>
- array
- <strong>jsonSerialize</strong>()</code>
- </h3>
- <div class="details">
- <div class="method-description">
- <p>Custom serialization of the ChartWrapper.</p> </div>
- <div class="tags">
-
- <h4>Return Value</h4>
- <table class="table table-condensed">
- <tr>
- <td>
- array</td>
- <td>
- </td>
- </tr>
- </table>
-
-
- </div>
- </div>
- </div>
- <div class="method-item">
- <h3 id="method_toJavascript">
- <div class="location">in
- <a href="../../../Khill/Lavacharts/Dashboards/Wrapper.html#method_toJavascript"><abbr title="Khill\Lavacharts\Dashboards\Wrapper">Wrapper</abbr></a> at line 97</div>
- <code>
- string
- <strong>toJavascript</strong>()</code>
- </h3>
- <div class="details">
- <div class="method-description">
- <p>Returns a javascript string with the constructor for the Wrapper.</p> </div>
- <div class="tags">
-
- <h4>Return Value</h4>
- <table class="table table-condensed">
- <tr>
- <td>
- string</td>
- <td>
- </td>
- </tr>
- </table>
-
-
- </div>
- </div>
- </div>
- </div>
-
- </div>
- <div id="footer">
- Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
- </div>
- </div>
- </div>
- </body>
- </html>