garrettmills/eecs448-project-4
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
06515b0559
eecs448-project-4/frontend/documentation/generated/GridActionButtonComponent.html

1088 lines
12 KiB
HTML
Raw Normal View History

Add front-end prototype to assets
2020-11-01 18:53:08 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: GridActionButtonComponent</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: GridActionButtonComponent</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>GridActionButtonComponent<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Component representing an action button that can be embedded in the shared grid.</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="GridActionButtonComponent"><span class="type-signature"></span>new GridActionButtonComponent<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GridActionButton.component.js.html">components/GridActionButton.component.js</a>, <a href="components_GridActionButton.component.js.html#line17">line 17</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li>Component</li>
</ul>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="color"><span class="type-signature"></span>color<span class="type-signature"> :string</span></h4>
<div class="description">
The CSS color of the action button.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GridActionButton.component.js.html">components/GridActionButton.component.js</a>, <a href="components_GridActionButton.component.js.html#line32">line 32</a>
</li></ul></dd>
</dl>
<h4 class="name" id="hidden"><span class="type-signature"></span>hidden<span class="type-signature"> :boolean</span></h4>
<div class="description">
If true, the action button will be hidden.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GridActionButton.component.js.html">components/GridActionButton.component.js</a>, <a href="components_GridActionButton.component.js.html#line38">line 38</a>
</li></ul></dd>
</dl>
<h4 class="name" id="text"><span class="type-signature"></span>text<span class="type-signature"> :string</span></h4>
<div class="description">
The text shown on the action button.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GridActionButton.component.js.html">components/GridActionButton.component.js</a>, <a href="components_GridActionButton.component.js.html#line26">line 26</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="on_click"><span class="type-signature"></span>on_click<span class="signature">($event)</span><span class="type-signature"></span></h4>
<div class="description">
Called when the button is clicked. Emits a click event and updates the text, color, and hide status.
</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>$event</code></td>
<td class="type">
<span class="param-type">MouseEvent</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GridActionButton.component.js.html">components/GridActionButton.component.js</a>, <a href="components_GridActionButton.component.js.html#line107">line 107</a>
</li></ul></dd>
</dl>
<h4 class="name" id="update_color"><span class="type-signature"></span>update_color<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Determine the color to show on the button based on the column definition.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GridActionButton.component.js.html">components/GridActionButton.component.js</a>, <a href="components_GridActionButton.component.js.html#line82">line 82</a>
</li></ul></dd>
</dl>
<h4 class="name" id="update_hidden"><span class="type-signature"></span>update_hidden<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Determine whether the button should be shown or not, based on the column definition.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GridActionButton.component.js.html">components/GridActionButton.component.js</a>, <a href="components_GridActionButton.component.js.html#line93">line 93</a>
</li></ul></dd>
</dl>
<h4 class="name" id="update_text"><span class="type-signature"></span>update_text<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Determine the text to show on the button based on the column definition.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GridActionButton.component.js.html">components/GridActionButton.component.js</a>, <a href="components_GridActionButton.component.js.html#line71">line 71</a>
</li></ul></dd>
</dl>
<h4 class="name" id="vue_on_create"><span class="type-signature">(async) </span>vue_on_create<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
<div class="description">
Called when the component is instantiated. Updates the text, color, and hide status.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GridActionButton.component.js.html">components/GridActionButton.component.js</a>, <a href="components_GridActionButton.component.js.html#line44">line 44</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;void></span>
</dd>
</dl>
<h4 class="name" id="watch_col"><span class="type-signature"></span>watch_col<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Called when the column value changes. Updates the text, color, and hide status.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GridActionButton.component.js.html">components/GridActionButton.component.js</a>, <a href="components_GridActionButton.component.js.html#line62">line 62</a>
</li></ul></dd>
</dl>
<h4 class="name" id="watch_row"><span class="type-signature"></span>watch_row<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Called when the row value changes. Updates the text, color, and hide status.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GridActionButton.component.js.html">components/GridActionButton.component.js</a>, <a href="components_GridActionButton.component.js.html#line53">line 53</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-routing.html">routing</a></li><li><a href="module-util.html">util</a></li></ul><h3>Classes</h3><ul><li><a href="AddPlayersComponent.html">AddPlayersComponent</a></li><li><a href="DraftBoardComponent.html">DraftBoardComponent</a></li><li><a href="GridActionButtonComponent.html">GridActionButtonComponent</a></li><li><a href="GridComponent.html">GridComponent</a></li><li><a href="LeagueComponent.html">LeagueComponent</a></li><li><a href="LinkComponent.html">LinkComponent</a></li><li><a href="module-routing-Router.html">Router</a></li><li><a href="MyTeamComponent.html">MyTeamComponent</a></li><li><a href="ScoresComponent.html">ScoresComponent</a></li><li><a href="TopLevelComponent.html">TopLevelComponent</a></li></ul><h3>Global</h3><ul><li><a href="global.html#GridCellRenderType">GridCellRenderType</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sun Oct 25 2020 12:32:18 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in New Issue Copy Permalink