eecs448-project-4/documentation/generated/AddPlayersComponent.html

1540 lines
18 KiB
HTML

<!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="frontend_src_components_pages_AddPlayers.component.js.html">frontend/src/components/pages/AddPlayers.component.js</a>, <a href="frontend_src_components_pages_AddPlayers.component.js.html#line60">line 60</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.&lt;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.&lt;object></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="frontend_src_components_pages_AddPlayers.component.js.html">frontend/src/components/pages/AddPlayers.component.js</a>, <a href="frontend_src_components_pages_AddPlayers.component.js.html#line99">line 99</a>
</li></ul></dd>
</dl>
<h4 class="name" id="filtered_players"><span class="type-signature"></span>filtered_players<span class="type-signature"> :Array.&lt;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.&lt;object></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="frontend_src_components_pages_AddPlayers.component.js.html">frontend/src/components/pages/AddPlayers.component.js</a>, <a href="frontend_src_components_pages_AddPlayers.component.js.html#line87">line 87</a>
</li></ul></dd>
</dl>
<h4 class="name" id="my_team"><span class="type-signature"></span>my_team<span class="type-signature"> :Array.&lt;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.&lt;object></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="frontend_src_components_pages_AddPlayers.component.js.html">frontend/src/components/pages/AddPlayers.component.js</a>, <a href="frontend_src_components_pages_AddPlayers.component.js.html#line81">line 81</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="frontend_src_components_pages_AddPlayers.component.js.html">frontend/src/components/pages/AddPlayers.component.js</a>, <a href="frontend_src_components_pages_AddPlayers.component.js.html#line75">line 75</a>
</li></ul></dd>
</dl>
<h4 class="name" id="possible_players"><span class="type-signature"></span>possible_players<span class="type-signature"> :Array.&lt;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.&lt;object></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="frontend_src_components_pages_AddPlayers.component.js.html">frontend/src/components/pages/AddPlayers.component.js</a>, <a href="frontend_src_components_pages_AddPlayers.component.js.html#line93">line 93</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="frontend_src_components_pages_AddPlayers.component.js.html">frontend/src/components/pages/AddPlayers.component.js</a>, <a href="frontend_src_components_pages_AddPlayers.component.js.html#line69">line 69</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="frontend_src_components_pages_AddPlayers.component.js.html">frontend/src/components/pages/AddPlayers.component.js</a>, <a href="frontend_src_components_pages_AddPlayers.component.js.html#line151">line 151</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="frontend_src_components_pages_AddPlayers.component.js.html">frontend/src/components/pages/AddPlayers.component.js</a>, <a href="frontend_src_components_pages_AddPlayers.component.js.html#line121">line 121</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="frontend_src_components_pages_AddPlayers.component.js.html">frontend/src/components/pages/AddPlayers.component.js</a>, <a href="frontend_src_components_pages_AddPlayers.component.js.html#line171">line 171</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="frontend_src_components_pages_AddPlayers.component.js.html">frontend/src/components/pages/AddPlayers.component.js</a>, <a href="frontend_src_components_pages_AddPlayers.component.js.html#line179">line 179</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="frontend_src_components_pages_AddPlayers.component.js.html">frontend/src/components/pages/AddPlayers.component.js</a>, <a href="frontend_src_components_pages_AddPlayers.component.js.html#line161">line 161</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="frontend_src_components_pages_AddPlayers.component.js.html">frontend/src/components/pages/AddPlayers.component.js</a>, <a href="frontend_src_components_pages_AddPlayers.component.js.html#line141">line 141</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="frontend_src_components_pages_AddPlayers.component.js.html">frontend/src/components/pages/AddPlayers.component.js</a>, <a href="frontend_src_components_pages_AddPlayers.component.js.html#line132">line 132</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 page is instantiated.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="frontend_src_components_pages_AddPlayers.component.js.html">frontend/src/components/pages/AddPlayers.component.js</a>, <a href="frontend_src_components_pages_AddPlayers.component.js.html#line105">line 105</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;void></span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-fake_data.html">fake_data</a></li><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="ActiveScope.html">ActiveScope</a></li><li><a href="AddPlayersComponent.html">AddPlayersComponent</a></li><li><a href="DraftBoard.html">DraftBoard</a></li><li><a href="DraftBoardComponent.html">DraftBoardComponent</a></li><li><a href="FrontendUnit.html">FrontendUnit</a></li><li><a href="GenerateMatchupsForWeekPatch.html">GenerateMatchupsForWeekPatch</a></li><li><a href="GenerateWeeklyResultsPatch.html">GenerateWeeklyResultsPatch</a></li><li><a href="GridActionButtonComponent.html">GridActionButtonComponent</a></li><li><a href="GridComponent.html">GridComponent</a></li><li><a href="Home.html">Home</a></li><li><a href="InjectUserTeam.html">InjectUserTeam</a></li><li><a href="LeagueComponent.html">LeagueComponent</a></li><li><a href="Lineup.html">Lineup</a></li><li><a href="LinkComponent.html">LinkComponent</a></li><li><a href="Matchup.html">Matchup</a></li><li><a href="module-routing-Router.html">Router</a></li><li><a href="MyTeamComponent.html">MyTeamComponent</a></li><li><a href="Player.html">Player</a></li><li><a href="ScoresComponent.html">ScoresComponent</a></li><li><a href="ScoresController.html">ScoresController</a></li><li><a href="SeedAPIDataPatch.html">SeedAPIDataPatch</a></li><li><a href="SeedWeeklyPlayerDataPatch.html">SeedWeeklyPlayerDataPatch</a></li><li><a href="SportsDataService.html">SportsDataService</a></li><li><a href="Team.html">Team</a></li><li><a href="Teams.html">Teams</a></li><li><a href="TopLevelComponent.html">TopLevelComponent</a></li><li><a href="User.html">User</a></li><li><a href="WeeklyPlayerStat.html">WeeklyPlayerStat</a></li><li><a href="WeeklyTeamStat.html">WeeklyTeamStat</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 Nov 08 2020 14:34:32 GMT-0600 (Central Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>