<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: MyTeamComponent</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: MyTeamComponent</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>MyTeamComponent<span class="signature">()</span><span class="type-signature"></span></h2> <div class="class-description">Component representing the my-team page.</div> </header> <article> <div class="container-overview"> <h2>Constructor</h2> <h4 class="name" id="MyTeamComponent"><span class="type-signature"></span>new MyTeamComponent<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_MyTeam.component.js.html">frontend/src/components/pages/MyTeam.component.js</a>, <a href="frontend_src_components_pages_MyTeam.component.js.html#line45">line 45</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="_original_team_name"><span class="type-signature"></span>_original_team_name<span class="type-signature"></span></h4> <div class="description"> Original team name to compare against. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="frontend_src_components_pages_MyTeam.component.js.html">frontend/src/components/pages/MyTeam.component.js</a>, <a href="frontend_src_components_pages_MyTeam.component.js.html#line53">line 53</a> </li></ul></dd> </dl> <h4 class="name" id="bench_players"><span class="type-signature"></span>bench_players<span class="type-signature"> :Array.<object></span></h4> <div class="description"> Players on the bench. </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="frontend_src_components_pages_MyTeam.component.js.html">frontend/src/components/pages/MyTeam.component.js</a>, <a href="frontend_src_components_pages_MyTeam.component.js.html#line91">line 91</a> </li></ul></dd> </dl> <h4 class="name" id="lineup_column_defs"><span class="type-signature"></span>lineup_column_defs<span class="type-signature"> :Array.<object></span></h4> <div class="description"> Column definitions for the starting/bench lineup grids. </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="frontend_src_components_pages_MyTeam.component.js.html">frontend/src/components/pages/MyTeam.component.js</a>, <a href="frontend_src_components_pages_MyTeam.component.js.html#line97">line 97</a> </li></ul></dd> </dl> <h4 class="name" id="moving_player"><span class="type-signature"></span>moving_player<span class="type-signature"> :undefined</span></h4> <div class="description"> The player currently being moved. If none, then will be set to undefined. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">undefined</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_MyTeam.component.js.html">frontend/src/components/pages/MyTeam.component.js</a>, <a href="frontend_src_components_pages_MyTeam.component.js.html#line78">line 78</a> </li></ul></dd> </dl> <h4 class="name" id="overall_column_defs"><span class="type-signature"></span>overall_column_defs<span class="type-signature"> :Array.<object></span></h4> <div class="description"> Column definitions for the overall team grid. </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="frontend_src_components_pages_MyTeam.component.js.html">frontend/src/components/pages/MyTeam.component.js</a>, <a href="frontend_src_components_pages_MyTeam.component.js.html#line163">line 163</a> </li></ul></dd> </dl> <h4 class="name" id="overall_data"><span class="type-signature"></span>overall_data<span class="type-signature"> :Array.<object></span></h4> <div class="description"> Data for the overall team grid (list of user's team players). </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="frontend_src_components_pages_MyTeam.component.js.html">frontend/src/components/pages/MyTeam.component.js</a>, <a href="frontend_src_components_pages_MyTeam.component.js.html#line190">line 190</a> </li></ul></dd> </dl> <h4 class="name" id="save_text"><span class="type-signature"></span>save_text<span class="type-signature"> :string</span></h4> <div class="description"> The text next to the save 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="frontend_src_components_pages_MyTeam.component.js.html">frontend/src/components/pages/MyTeam.component.js</a>, <a href="frontend_src_components_pages_MyTeam.component.js.html#line65">line 65</a> </li></ul></dd> </dl> <h4 class="name" id="show_body"><span class="type-signature"></span>show_body<span class="type-signature"> :boolean</span></h4> <div class="description"> If true, the body of the page will be shown. Otherwise, hidden. This is used to refresh the entire component at once. </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_MyTeam.component.js.html">frontend/src/components/pages/MyTeam.component.js</a>, <a href="frontend_src_components_pages_MyTeam.component.js.html#line72">line 72</a> </li></ul></dd> </dl> <h4 class="name" id="starting_players"><span class="type-signature"></span>starting_players<span class="type-signature"> :Array.<object></span></h4> <div class="description"> Array of players filling starting line up positions. If no player is in a position, then only the "postition" key will be set. </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="frontend_src_components_pages_MyTeam.component.js.html">frontend/src/components/pages/MyTeam.component.js</a>, <a href="frontend_src_components_pages_MyTeam.component.js.html#line85">line 85</a> </li></ul></dd> </dl> <h4 class="name" id="team_name"><span class="type-signature"></span>team_name<span class="type-signature"> :string</span></h4> <div class="description"> The team name. </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_MyTeam.component.js.html">frontend/src/components/pages/MyTeam.component.js</a>, <a href="frontend_src_components_pages_MyTeam.component.js.html#line59">line 59</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Force re-render the entire component by briefly hiding it. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="frontend_src_components_pages_MyTeam.component.js.html">frontend/src/components/pages/MyTeam.component.js</a>, <a href="frontend_src_components_pages_MyTeam.component.js.html#line212">line 212</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 component is instantiated. Initializes the bench players data. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="frontend_src_components_pages_MyTeam.component.js.html">frontend/src/components/pages/MyTeam.component.js</a>, <a href="frontend_src_components_pages_MyTeam.component.js.html#line196">line 196</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<void></span> </dd> </dl> <h4 class="name" id="watch_team_name"><span class="type-signature"></span>watch_team_name<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Fired when the team name changes. Marks the data as needing a save. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="frontend_src_components_pages_MyTeam.component.js.html">frontend/src/components/pages/MyTeam.component.js</a>, <a href="frontend_src_components_pages_MyTeam.component.js.html#line227">line 227</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-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>