<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: ScoresComponent</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: ScoresComponent</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>ScoresComponent<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Component representing the scores & match-ups page.</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="ScoresComponent"><span class="type-signature"></span>new ScoresComponent<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_Scores.component.js.html">components/pages/Scores.component.js</a>, <a href="components_pages_Scores.component.js.html#line26">line 26</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="column_defs"><span class="type-signature"></span>column_defs<span class="type-signature"> :Array.<object></span></h4>
<div class="description">
Column definitions for the matchups 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="components_pages_Scores.component.js.html">components/pages/Scores.component.js</a>, <a href="components_pages_Scores.component.js.html#line258">line 258</a>
</li></ul></dd>
</dl>
<h4 class="name" id="current_week"><span class="type-signature"></span>current_week<span class="type-signature"> :number</span></h4>
<div class="description">
The number of the current week shown in the interface
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_pages_Scores.component.js.html">components/pages/Scores.component.js</a>, <a href="components_pages_Scores.component.js.html#line35">line 35</a>
</li></ul></dd>
</dl>
<h4 class="name" id="data"><span class="type-signature"></span>data<span class="type-signature"> :Array.<object></span></h4>
<div class="description">
The currently shown week's data.
</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_Scores.component.js.html">components/pages/Scores.component.js</a>, <a href="components_pages_Scores.component.js.html#line316">line 316</a>
</li></ul></dd>
</dl>
<h4 class="name" id="max_week"><span class="type-signature"></span>max_week<span class="type-signature"> :number</span></h4>
<div class="description">
Most recent week number.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_pages_Scores.component.js.html">components/pages/Scores.component.js</a>, <a href="components_pages_Scores.component.js.html#line41">line 41</a>
</li></ul></dd>
</dl>
<h4 class="name" id="min_week"><span class="type-signature"></span>min_week<span class="type-signature"> :number</span></h4>
<div class="description">
Least recent week number.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_pages_Scores.component.js.html">components/pages/Scores.component.js</a>, <a href="components_pages_Scores.component.js.html#line47">line 47</a>
</li></ul></dd>
</dl>
<h4 class="name" id="week_x_data"><span class="type-signature"></span>week_x_data<span class="type-signature"> :Array.<Array.<object>></span></h4>
<div class="description">
Array of arrays of data for each week with first item being week 1, second being week 2, &c.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<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_Scores.component.js.html">components/pages/Scores.component.js</a>, <a href="components_pages_Scores.component.js.html#line53">line 53</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="to_next_week"><span class="type-signature"></span>to_next_week<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
When called, advances the data to the next-most recent week, if one exists.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_pages_Scores.component.js.html">components/pages/Scores.component.js</a>, <a href="components_pages_Scores.component.js.html#line329">line 329</a>
</li></ul></dd>
</dl>
<h4 class="name" id="to_previous_week"><span class="type-signature"></span>to_previous_week<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
When called, advances the data to the next-least recent week, if one exists.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_pages_Scores.component.js.html">components/pages/Scores.component.js</a>, <a href="components_pages_Scores.component.js.html#line339">line 339</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 current week to the most recent week.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_pages_Scores.component.js.html">components/pages/Scores.component.js</a>, <a href="components_pages_Scores.component.js.html#line322">line 322</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>