<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: AddPlayersComponent</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: AddPlayersComponent</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>AddPlayersComponent<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">A component which represents the "Add Players" page. Allows users to add/remove
players from their team.</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="AddPlayersComponent"><span class="type-signature"></span>new AddPlayersComponent<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_pages_AddPlayers.component.js.html">components/pages/AddPlayers.component.js</a>, <a href="components_pages_AddPlayers.component.js.html#line57">line 57</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="all_players"><span class="type-signature"></span>all_players<span class="type-signature"> :Array.<object></span></h4>
<div class="description">
All available players, whether they are on the user's team or not.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<object></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_pages_AddPlayers.component.js.html">components/pages/AddPlayers.component.js</a>, <a href="components_pages_AddPlayers.component.js.html#line96">line 96</a>
</li></ul></dd>
</dl>
<h4 class="name" id="filtered_players"><span class="type-signature"></span>filtered_players<span class="type-signature"> :Array.<object></span></h4>
<div class="description">
Array of currently displayed players, after the filter has been applied.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<object></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_pages_AddPlayers.component.js.html">components/pages/AddPlayers.component.js</a>, <a href="components_pages_AddPlayers.component.js.html#line84">line 84</a>
</li></ul></dd>
</dl>
<h4 class="name" id="my_team"><span class="type-signature"></span>my_team<span class="type-signature"> :Array.<object></span></h4>
<div class="description">
Array of players currently on the user's team.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<object></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_pages_AddPlayers.component.js.html">components/pages/AddPlayers.component.js</a>, <a href="components_pages_AddPlayers.component.js.html#line78">line 78</a>
</li></ul></dd>
</dl>
<h4 class="name" id="my_team_only"><span class="type-signature"></span>my_team_only<span class="type-signature"> :boolean</span></h4>
<div class="description">
If true, then only the players on the user's team will be shown.
</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_pages_AddPlayers.component.js.html">components/pages/AddPlayers.component.js</a>, <a href="components_pages_AddPlayers.component.js.html#line72">line 72</a>
</li></ul></dd>
</dl>
<h4 class="name" id="possible_players"><span class="type-signature"></span>possible_players<span class="type-signature"> :Array.<object></span></h4>
<div class="description">
Array of currently displayed players, before the filter has been applied.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<object></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_pages_AddPlayers.component.js.html">components/pages/AddPlayers.component.js</a>, <a href="components_pages_AddPlayers.component.js.html#line90">line 90</a>
</li></ul></dd>
</dl>
<h4 class="name" id="quick_filter"><span class="type-signature"></span>quick_filter<span class="type-signature"> :string</span></h4>
<div class="description">
The current value of the quick filter for players. If empty string, no filter is applied.
</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_pages_AddPlayers.component.js.html">components/pages/AddPlayers.component.js</a>, <a href="components_pages_AddPlayers.component.js.html#line66">line 66</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="add_to_team"><span class="type-signature"></span>add_to_team<span class="signature">(player)</span><span class="type-signature"></span></h4>
<div class="description">
Add the given player to the user's team, if not already there.
</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>player</code></td>
<td class="type">
<span class="param-type">object</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_pages_AddPlayers.component.js.html">components/pages/AddPlayers.component.js</a>, <a href="components_pages_AddPlayers.component.js.html#line557">line 557</a>
</li></ul></dd>
</dl>
<h4 class="name" id="on_filter_change"><span class="type-signature"></span>on_filter_change<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Called when the quick-filter changes. Applies the filter to the displayed players.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_pages_AddPlayers.component.js.html">components/pages/AddPlayers.component.js</a>, <a href="components_pages_AddPlayers.component.js.html#line527">line 527</a>
</li></ul></dd>
</dl>
<h4 class="name" id="on_photo_hover"><span class="type-signature"></span>on_photo_hover<span class="signature">(player)</span><span class="type-signature"></span></h4>
<div class="description">
Called when the user hovers over a player. Toggles the stats to be shown.
</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>player</code></td>
<td class="type">
<span class="param-type">object</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_pages_AddPlayers.component.js.html">components/pages/AddPlayers.component.js</a>, <a href="components_pages_AddPlayers.component.js.html#line577">line 577</a>
</li></ul></dd>
</dl>
<h4 class="name" id="on_photo_leave"><span class="type-signature"></span>on_photo_leave<span class="signature">(player)</span><span class="type-signature"></span></h4>
<div class="description">
Called when the user un-hovers over a player. Toggles the stats to hide.
</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>player</code></td>
<td class="type">
<span class="param-type">object</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_pages_AddPlayers.component.js.html">components/pages/AddPlayers.component.js</a>, <a href="components_pages_AddPlayers.component.js.html#line585">line 585</a>
</li></ul></dd>
</dl>
<h4 class="name" id="remove_from_team"><span class="type-signature"></span>remove_from_team<span class="signature">(player)</span><span class="type-signature"></span></h4>
<div class="description">
Remove the given player from the user's team, if there.
</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>player</code></td>
<td class="type">
<span class="param-type">object</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_pages_AddPlayers.component.js.html">components/pages/AddPlayers.component.js</a>, <a href="components_pages_AddPlayers.component.js.html#line567">line 567</a>
</li></ul></dd>
</dl>
<h4 class="name" id="to_all_players"><span class="type-signature"></span>to_all_players<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
When called, change the display to show all available players.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_pages_AddPlayers.component.js.html">components/pages/AddPlayers.component.js</a>, <a href="components_pages_AddPlayers.component.js.html#line547">line 547</a>
</li></ul></dd>
</dl>
<h4 class="name" id="to_my_team_only"><span class="type-signature"></span>to_my_team_only<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
When called, change the display to show only the user's team.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_pages_AddPlayers.component.js.html">components/pages/AddPlayers.component.js</a>, <a href="components_pages_AddPlayers.component.js.html#line538">line 538</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"> → {Promise.<void>}</span></h4>
<div class="description">
Called when the page is instantiated.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_pages_AddPlayers.component.js.html">components/pages/AddPlayers.component.js</a>, <a href="components_pages_AddPlayers.component.js.html#line519">line 519</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<void></span>
</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>