Skip to content
This repository has been archived by the owner on Jun 15, 2019. It is now read-only.

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jamestalmage committed Dec 19, 2014
1 parent 5addc3e commit 9ce6b75
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions src/cell.js
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,9 @@ Cell.prototype.init = function(tableOptions){
* Draws the given line of the cell.
* This default implementation defers to methods `drawTop`, `drawBottom`, `drawLine` and `drawEmpty`.
* @param lineNum - can be `top`, `bottom` or a numerical line number.
* @param spanningCell - will be a number if being called from a RowSpanCell, and will represent how
* many rows below it's being called from. Otherwise it's undefined.
* @returns {String} The representation of this line.
* @param spanningCell
*/
Cell.prototype.draw = function(lineNum,spanningCell){
if(lineNum == 'top') return this.drawTop(this.drawRight);
Expand Down Expand Up @@ -180,6 +181,7 @@ Cell.prototype.wrapWithStyleColors = function(styleProperty,content){
* @param forceTruncationSymbol - `true` if the rendered text should end with the truncation symbol even
* if the text fits. This is used when the cell is vertically truncated. If `false` the text should
* only include the truncation symbol if the text will not fit horizontally within the cell width.
* @param spanningCell - a number of if being called from a RowSpanCell. (how many rows below). otherwise undefined.
* @returns {String}
*/
Cell.prototype.drawLine = function(lineNum,drawRight,forceTruncationSymbol,spanningCell){
Expand Down Expand Up @@ -216,7 +218,7 @@ Cell.prototype.stylizeLine = function(left,content,right){

/**
* Renders the bottom line of the cell.
* @param drawRight - true if this method should render the right edge of the cell
* @param drawRight - true if this method should render the right edge of the cell.
* @returns {String}
*/
Cell.prototype.drawBottom = function(drawRight){
Expand All @@ -228,7 +230,8 @@ Cell.prototype.drawBottom = function(drawRight){

/**
* Renders a blank line of text within the cell. Used for top and/or bottom padding.
* @param drawRight - true if this method should render the right edge of the cell
* @param drawRight - true if this method should render the right edge of the cell.
* @param spanningCell - a number of if being called from a RowSpanCell. (how many rows below). otherwise undefined.
* @returns {String}
*/
Cell.prototype.drawEmpty = function(drawRight,spanningCell){
Expand Down

0 comments on commit 9ce6b75

Please sign in to comment.