PageRenderTime 26ms CodeModel.GetById 10ms RepoModel.GetById 0ms app.codeStats 0ms

/build/master/Khill/Lavacharts/Dashboards/ChartWrapper.html

https://gitlab.com/kevinkhill/lavacharts-api
HTML | 342 lines | 279 code | 63 blank | 0 comment | 0 complexity | b47ecb091a5b790a328300053d8d0029 MD5 | raw file
    

  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4.     <meta charset="UTF-8" />
    5. 

  5.     <meta name="robots" content="index, follow, all" />
    6. 

  6.     <title>Khill\Lavacharts\Dashboards\ChartWrapper | Lavacharts API</title>
    7. 

  7. 

  8.                 <link rel="stylesheet" type="text/css" href="../../../css/bootstrap.min.css">
    9. 

  9.         <link rel="stylesheet" type="text/css" href="../../../css/bootstrap-theme.min.css">
    10. 

  10.         <link rel="stylesheet" type="text/css" href="../../../css/sami.css">
    11. 

  11.         <script src="../../../js/jquery-1.11.1.min.js"></script>
    12. 

  12.         <script src="../../../js/bootstrap.min.js"></script>
    13. 

  13.         <script src="../../../js/typeahead.min.js"></script>
    14. 

  14.         <script src="../../../sami.js"></script>
    15. 

  15.         <meta name="MobileOptimized" content="width">
    16. 

  16.         <meta name="HandheldFriendly" content="true">
    17. 

  17.         <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
    18. 

  18.     
    19. 

  19.     <link rel="icon" href="../../../images/favicon.ico" type="image/x-icon">
    20. 

  20. 

  21.     
    22. 

  22.     </head>
    23. 

  23. 

  24.     <body id="class" data-name="class:Khill_Lavacharts_Dashboards_ChartWrapper" data-root-path="../../../">
    25. 

  25.             <div id="content">
    26. 

  26.         <div id="left-column">
    27. 

  27.                 <div id="control-panel">
    28. 

  28.                 <form id="search-form" action="../../../search.html" method="GET">
    29. 

  29.             <span class="glyphicon glyphicon-search"></span>
    30. 

  30.             <input name="search"
    31. 

  31.                    class="typeahead form-control"
    32. 

  32.                    type="search"
    33. 

  33.                    placeholder="Search">
    34. 

  34.         </form>
    35. 

  35.     </div>
    36. 

  36. 

  37.                 <div id="api-tree"></div>
    38. 

  38. 

  39.         </div>
    40. 

  40.         <div id="right-column">
    41. 

  41.                 <nav id="site-nav" class="navbar navbar-default" role="navigation">
    42. 

  42.         <div class="container-fluid">
    43. 

  43.             <div class="navbar-header">
    44. 

  44.                 <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
    45. 

  45.                     <span class="sr-only">Toggle navigation</span>
    46. 

  46.                     <span class="icon-bar"></span>
    47. 

  47.                     <span class="icon-bar"></span>
    48. 

  48.                     <span class="icon-bar"></span>
    49. 

  49.                 </button>
    50. 

  50.                 <a class="navbar-brand" href="../../../index.html">
    51. 

  51.                     <img src="../../../images/lava-logo.gif" />
    52. 

  52.                                     </a>
    53. 

  53.             </div>
    54. 

  54.             <div class="collapse navbar-collapse" id="navbar-elements">
    55. 

  55.                 <ul class="nav navbar-nav">
    56. 

  56.                     <li><a href="../../../classes.html">Classes</a></li>
    57. 

  57.                                             <li><a href="../../../namespaces.html">Namespaces</a></li>
    58. 

  58.                                         <li><a href="../../../interfaces.html">Interfaces</a></li>
    59. 

  59.                     <li><a href="../../../traits.html">Traits</a></li>
    60. 

  60.                     <li><a href="../../../doc-index.html">Index</a></li>
    61. 

  61.                     <li><a href="../../../search.html">Search</a></li>
    62. 

  62.                 </ul>
    63. 

  63.             </div>
    64. 

  64.         </div>
    65. 

  65.     </nav>
    66. 

  66. 

  67.                         <div class="namespace-breadcrumbs">
    68. 

  68.             <ol class="breadcrumb">
    69. 

  69.                 <li><span class="label label-default">class</span></li>
    70. 

  70.                                                             <li><a href="../../../Khill.html">Khill</a></li>
    71. 

  71.                                         <li><a href="../../../Khill/Lavacharts.html">Lavacharts</a></li>
    72. 

  72.                                         <li><a href="../../../Khill/Lavacharts/Dashboards.html">Dashboards</a></li>
    73. 

  73.     
    74. 

  74.                 <li>ChartWrapper</li>
    75. 

  75.             </ol>
    76. 

  76.         </div>
    77. 

  77.                 <div id="page-content">
    78. 

  78.                 
    79. 

  79.     <div class="page-header">
    80. 

  80.         <h1>ChartWrapper</h1>
    81. 

  81.     </div>
    82. 

  82. 

  83.     <p>    class
    84. 

  84.     <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>)
    85. 

  85. </p>
    86. 

  86. 

  87.             <div class="description">
    88. 

  88.             <p>ChartWrapper Class</p>            <p>Used for wrapping charts to use in dashboards.</p>        </div>
    89. 

  89.     
    90. 

  90.     
    91. 

  91.             <h2>Constants</h2>
    92. 

  92. 

  93.             <table class="table table-condensed">
    94. 

  94.                     <tr>
    95. 

  95.                 <td>VIZ_CLASS</td>
    96. 

  96.                 <td class="last">
    97. 

  97.                     <p><em>Javascript chart class.</em></p>
    98. 

  98.                     <p>
    99. 

  99. </p>
    100. 

  100.                 </td>
    101. 

  101.             </tr>
    102. 

  102.             </table>
    103. 

  103. 

  104.     
    105. 

  105.     
    106. 

  106.             <h2>Methods</h2>
    107. 

  107. 

  108.             <div class="container-fluid underlined">
    109. 

  109.                     <div class="row">
    110. 

  110.                 <div class="col-md-2 type">
    111. 

  111.                     
    112. 

  112.     
    113. 

  113.                 </div>
    114. 

  114.                 <div class="col-md-8 type">
    115. 

  115.                     <a href="#method___construct">__construct</a>(
    116. 

  116.     <abbr title="Khill\Lavacharts\Dashboards\Khill\Lavacharts\Charts\Chart">Chart</abbr> $chart, 
    117. 

  117.     <abbr title="Khill\Lavacharts\Dashboards\Khill\Lavacharts\Values\ElementId">ElementId</abbr> $containerId)
    118. 

  118.                                             <p>Builds a ChartWrapper object.</p>                </div>
    119. 

  119.                 <div class="col-md-2"></div>
    120. 

  120.             </div>
    121. 

  121.                     <div class="row">
    122. 

  122.                 <div class="col-md-2 type">
    123. 

  123.                     
    124. 

  124.     <a href="../../../Khill/Lavacharts/Values/ElementId.html"><abbr title="Khill\Lavacharts\Values\ElementId">ElementId</abbr></a>
    125. 

  125.                 </div>
    126. 

  126.                 <div class="col-md-8 type">
    127. 

  127.                     <a href="#method_getContainerId">getContainerId</a>()
    128. 

  128.                                             <p>Returns the container id.</p>                </div>
    129. 

  129.                 <div class="col-md-2"><small>from&nbsp;
    130. 

  130.     <a href="../../../Khill/Lavacharts/Dashboards/Wrapper.html#method_getContainerId"><abbr title="Khill\Lavacharts\Dashboards\Wrapper">Wrapper</abbr></a></small></div>
    131. 

  131.             </div>
    132. 

  132.                     <div class="row">
    133. 

  133.                 <div class="col-md-2 type">
    134. 

  134.                     
    135. 

  135.     <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>
    136. 

  136.                 </div>
    137. 

  137.                 <div class="col-md-8 type">
    138. 

  138.                     <a href="#method_unwrap">unwrap</a>()
    139. 

  139.                                             <p>Unwraps and returns the wrapped object.</p>                </div>
    140. 

  140.                 <div class="col-md-2"><small>from&nbsp;
    141. 

  141.     <a href="../../../Khill/Lavacharts/Dashboards/Wrapper.html#method_unwrap"><abbr title="Khill\Lavacharts\Dashboards\Wrapper">Wrapper</abbr></a></small></div>
    142. 

  142.             </div>
    143. 

  143.                     <div class="row">
    144. 

  144.                 <div class="col-md-2 type">
    145. 

  145.                     
    146. 

  146.     array
    147. 

  147.                 </div>
    148. 

  148.                 <div class="col-md-8 type">
    149. 

  149.                     <a href="#method_jsonSerialize">jsonSerialize</a>()
    150. 

  150.                                             <p>Custom serialization of the ChartWrapper.</p>                </div>
    151. 

  151.                 <div class="col-md-2"><small>from&nbsp;
    152. 

  152.     <a href="../../../Khill/Lavacharts/Dashboards/Wrapper.html#method_jsonSerialize"><abbr title="Khill\Lavacharts\Dashboards\Wrapper">Wrapper</abbr></a></small></div>
    153. 

  153.             </div>
    154. 

  154.                     <div class="row">
    155. 

  155.                 <div class="col-md-2 type">
    156. 

  156.                     
    157. 

  157.     string
    158. 

  158.                 </div>
    159. 

  159.                 <div class="col-md-8 type">
    160. 

  160.                     <a href="#method_toJavascript">toJavascript</a>()
    161. 

  161.                                             <p>Returns a javascript string with the constructor for the Wrapper.</p>                </div>
    162. 

  162.                 <div class="col-md-2"><small>from&nbsp;
    163. 

  163.     <a href="../../../Khill/Lavacharts/Dashboards/Wrapper.html#method_toJavascript"><abbr title="Khill\Lavacharts\Dashboards\Wrapper">Wrapper</abbr></a></small></div>
    164. 

  164.             </div>
    165. 

  165.             </div>
    166. 

  166. 

  167. 

  168.         <h2>Details</h2>
    169. 

  169. 

  170.             <div id="method-details">
    171. 

  171.                     <div class="method-item">
    172. 

  172.                     <h3 id="method___construct">
    173. 

  173.         <div class="location">at line 37</div>
    174. 

  174.         <code>                    
    175. 

  175.     
    176. 

  176.     <strong>__construct</strong>(
    177. 

  177.     <abbr title="Khill\Lavacharts\Dashboards\Khill\Lavacharts\Charts\Chart">Chart</abbr> $chart, 
    178. 

  178.     <abbr title="Khill\Lavacharts\Dashboards\Khill\Lavacharts\Values\ElementId">ElementId</abbr> $containerId)</code>
    179. 

  179.     </h3>
    180. 

  180.     <div class="details">
    181. 

  181.                     <div class="method-description">
    182. 

  182.                                     <p>Builds a ChartWrapper object.</p>                                </div>
    183. 

  183.                 <div class="tags">
    184. 

  184.                             <h4>Parameters</h4>
    185. 

  185. 

  186.                     <table class="table table-condensed">
    187. 

  187.                     <tr>
    188. 

  188.                 <td>
    189. 

  189.     <abbr title="Khill\Lavacharts\Dashboards\Khill\Lavacharts\Charts\Chart">Chart</abbr></td>
    190. 

  190.                 <td>$chart</td>
    191. 

  191.                 <td>
    192. 

  192. </td>
    193. 

  193.             </tr>
    194. 

  194.                     <tr>
    195. 

  195.                 <td>
    196. 

  196.     <abbr title="Khill\Lavacharts\Dashboards\Khill\Lavacharts\Values\ElementId">ElementId</abbr></td>
    197. 

  197.                 <td>$containerId</td>
    198. 

  198.                 <td>
    199. 

  199. </td>
    200. 

  200.             </tr>
    201. 

  201.             </table>
    202. 

  202. 

  203.             
    204. 

  204.             
    205. 

  205.             
    206. 

  206.                     </div>
    207. 

  207.     </div>
    208. 

  208. 

  209.             </div>
    210. 

  210.                     <div class="method-item">
    211. 

  211.                     <h3 id="method_getContainerId">
    212. 

  212.         <div class="location">in 
    213. 

  213.     <a href="../../../Khill/Lavacharts/Dashboards/Wrapper.html#method_getContainerId"><abbr title="Khill\Lavacharts\Dashboards\Wrapper">Wrapper</abbr></a> at line 55</div>
    214. 

  214.         <code>                    
    215. 

  215.     <a href="../../../Khill/Lavacharts/Values/ElementId.html"><abbr title="Khill\Lavacharts\Values\ElementId">ElementId</abbr></a>
    216. 

  216.     <strong>getContainerId</strong>()</code>
    217. 

  217.     </h3>
    218. 

  218.     <div class="details">
    219. 

  219.                     <div class="method-description">
    220. 

  220.                                     <p>Returns the container id.</p>                                </div>
    221. 

  221.                 <div class="tags">
    222. 

  222.             
    223. 

  223.                             <h4>Return Value</h4>
    224. 

  224. 

  225.                     <table class="table table-condensed">
    226. 

  226.         <tr>
    227. 

  227.             <td>
    228. 

  228.     <a href="../../../Khill/Lavacharts/Values/ElementId.html"><abbr title="Khill\Lavacharts\Values\ElementId">ElementId</abbr></a></td>
    229. 

  229.             <td>
    230. 

  230. </td>
    231. 

  231.         </tr>
    232. 

  232.     </table>
    233. 

  233. 

  234.             
    235. 

  235.             
    236. 

  236.                     </div>
    237. 

  237.     </div>
    238. 

  238. 

  239.             </div>
    240. 

  240.                     <div class="method-item">
    241. 

  241.                     <h3 id="method_unwrap">
    242. 

  242.         <div class="location">in 
    243. 

  243.     <a href="../../../Khill/Lavacharts/Dashboards/Wrapper.html#method_unwrap"><abbr title="Khill\Lavacharts\Dashboards\Wrapper">Wrapper</abbr></a> at line 65</div>
    244. 

  244.         <code>                    
    245. 

  245.     <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>
    246. 

  246.     <strong>unwrap</strong>()</code>
    247. 

  247.     </h3>
    248. 

  248.     <div class="details">
    249. 

  249.                     <div class="method-description">
    250. 

  250.                                     <p>Unwraps and returns the wrapped object.</p>                                </div>
    251. 

  251.                 <div class="tags">
    252. 

  252.             
    253. 

  253.                             <h4>Return Value</h4>
    254. 

  254. 

  255.                     <table class="table table-condensed">
    256. 

  256.         <tr>
    257. 

  257.             <td>
    258. 

  258.     <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>
    259. 

  259.             <td>
    260. 

  260. </td>
    261. 

  261.         </tr>
    262. 

  262.     </table>
    263. 

  263. 

  264.             
    265. 

  265.             
    266. 

  266.                     </div>
    267. 

  267.     </div>
    268. 

  268. 

  269.             </div>
    270. 

  270.                     <div class="method-item">
    271. 

  271.                     <h3 id="method_jsonSerialize">
    272. 

  272.         <div class="location">in 
    273. 

  273.     <a href="../../../Khill/Lavacharts/Dashboards/Wrapper.html#method_jsonSerialize"><abbr title="Khill\Lavacharts\Dashboards\Wrapper">Wrapper</abbr></a> at line 75</div>
    274. 

  274.         <code>                    
    275. 

  275.     array
    276. 

  276.     <strong>jsonSerialize</strong>()</code>
    277. 

  277.     </h3>
    278. 

  278.     <div class="details">
    279. 

  279.                     <div class="method-description">
    280. 

  280.                                     <p>Custom serialization of the ChartWrapper.</p>                                </div>
    281. 

  281.                 <div class="tags">
    282. 

  282.             
    283. 

  283.                             <h4>Return Value</h4>
    284. 

  284. 

  285.                     <table class="table table-condensed">
    286. 

  286.         <tr>
    287. 

  287.             <td>
    288. 

  288.     array</td>
    289. 

  289.             <td>
    290. 

  290. </td>
    291. 

  291.         </tr>
    292. 

  292.     </table>
    293. 

  293. 

  294.             
    295. 

  295.             
    296. 

  296.                     </div>
    297. 

  297.     </div>
    298. 

  298. 

  299.             </div>
    300. 

  300.                     <div class="method-item">
    301. 

  301.                     <h3 id="method_toJavascript">
    302. 

  302.         <div class="location">in 
    303. 

  303.     <a href="../../../Khill/Lavacharts/Dashboards/Wrapper.html#method_toJavascript"><abbr title="Khill\Lavacharts\Dashboards\Wrapper">Wrapper</abbr></a> at line 97</div>
    304. 

  304.         <code>                    
    305. 

  305.     string
    306. 

  306.     <strong>toJavascript</strong>()</code>
    307. 

  307.     </h3>
    308. 

  308.     <div class="details">
    309. 

  309.                     <div class="method-description">
    310. 

  310.                                     <p>Returns a javascript string with the constructor for the Wrapper.</p>                                </div>
    311. 

  311.                 <div class="tags">
    312. 

  312.             
    313. 

  313.                             <h4>Return Value</h4>
    314. 

  314. 

  315.                     <table class="table table-condensed">
    316. 

  316.         <tr>
    317. 

  317.             <td>
    318. 

  318.     string</td>
    319. 

  319.             <td>
    320. 

  320. </td>
    321. 

  321.         </tr>
    322. 

  322.     </table>
    323. 

  323. 

  324.             
    325. 

  325.             
    326. 

  326.                     </div>
    327. 

  327.     </div>
    328. 

  328. 

  329.             </div>
    330. 

  330.             </div>
    331. 

  331. 

  332.     
    333. 

  333.             </div>
    334. 

  334.                 <div id="footer">
    335. 

  335.         Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
    336. 

  336.     </div>
    337. 

  337. 

  338.         </div>
    339. 

  339.     </div>
    340. 

  340.     </body>
    341. 

  341. 

  342. </html>
    343. 

  343.