simple-spreadsheet-reader › Globals › “spreadsheetReader” › SpreadsheetReader
Class: SpreadsheetReader
A simple reader for a Google spreadsheet publish on web.
Hierarchy
- SpreadsheetReader
Index
Constructors
Properties
Accessors
Methods
- createHeadCell
- generateTable
- getAllLines
- getCellValue
- getTable
- loadSpreadsheetData
- processSpreadsheets
- formatColl
- lettersGenerator
- numberGenerator
Constructors
constructor
+ new SpreadsheetReader(spreadsheetsUrlOrId: string): SpreadsheetReader
Defined in spreadsheetReader.ts:73
Parameters:
| Name | Type |
|---|---|
spreadsheetsUrlOrId |
string |
Returns: SpreadsheetReader
Properties
Protected Optional _cellsList
• _cellsList? : Array‹SpredsheedCell›
Defined in spreadsheetReader.ts:24
Protected Optional _maxColl
| • _maxColl? : *undefined | string* |
Defined in spreadsheetReader.ts:26
Protected Optional _maxRaw
| • _maxRaw? : *undefined | number* |
Defined in spreadsheetReader.ts:25
Protected Optional _rawJson
• _rawJson? : GoogleJsonSpreadsheet
Defined in spreadsheetReader.ts:23
Protected Optional _xmlError
| • _xmlError? : *undefined | string* |
Defined in spreadsheetReader.ts:22
Protected httpClient
• httpClient: HttpClient
Defined in spreadsheetReader.ts:21
Protected Optional spreadsheetsIs
| • spreadsheetsIs? : *undefined | string* |
Defined in spreadsheetReader.ts:20
Accessors
cellsList
• get cellsList(): Array‹SpredsheedCell›
Defined in spreadsheetReader.ts:48
List od cells loaded from google spreadsheet
Returns: Array‹SpredsheedCell›
maxColl
• get maxColl(): string
Defined in spreadsheetReader.ts:68
get the number of column used in the spreadsheet.
Returns: string
maxRaw
• get maxRaw(): number
Defined in spreadsheetReader.ts:58
get the number of raw used in the spreadsheet
Returns: number
rawJson
• get rawJson(): GoogleJsonSpreadsheet
Defined in spreadsheetReader.ts:38
get raw JSON loaded from google spreadsheet
Returns: GoogleJsonSpreadsheet
xmlError
| • get xmlError(): *string | undefined* |
Defined in spreadsheetReader.ts:31
XML string of the error message
| Returns: *string | undefined* |
Methods
Protected createHeadCell
▸ createHeadCell(cellContaint: string |
undefined): HTMLTableDataCellElement |
Defined in spreadsheetReader.ts:242
Parameters:
| Name | Type |
|---|---|
cellContaint |
string | undefined |
Returns: HTMLTableDataCellElement
Protected generateTable
▸ generateTable(maxRaw: number, maxCell: string): HTMLTableElement
Defined in spreadsheetReader.ts:249
Parameters:
| Name | Type |
|---|---|
maxRaw |
number |
maxCell |
string |
Returns: HTMLTableElement
getAllLines
| ▸ getAllLines(): *Array‹Array‹string | undefined››* |
Defined in spreadsheetReader.ts:132
gel all lines of the spreadsheet in an array of array
| Returns: *Array‹Array‹string | undefined››* |
getCellValue
▸ getCellValue(cellId: string): *string |
undefined* |
Defined in spreadsheetReader.ts:125
get value of a cell
Parameters:
| Name | Type | Description |
|---|---|---|
cellId |
string |
| Returns: *string | undefined* |
getTable
▸ getTable(): Node
Defined in spreadsheetReader.ts:201
Compute Node elements of the table. In case of errors the node will contains the error message.
classes
- ssr-table: class of the root elements of the table
- ssr-cell-head: class of header cells
- ssr-cell-data: class of cells contains data
id
- All data Element have id=”ssr-${cellID}”
results HTML
<table class="ssr-table">
<thead>
<tr>
<td class="ssr-cell-head"></td>
<td class="ssr-cell-head">A</td>
<td class="ssr-cell-head">B</td>
</tr>
</thead>
<tbody>
<tr>
<td class="ssr-cell-head">1</td>
<td cell-id="A1" id="ssr-A1" class="ssr-cell-data">text</td>
<td cell-id="B1" id="ssr-B1" class="ssr-cell-data">value</td>
</tr>
<tr>
<td class="ssr-cell-head">2</td>
<td cell-id="A2" id="ssr-A2" class="ssr-cell-data"></td>
<td cell-id="B2" id="ssr-B2" class="ssr-cell-data">other</td>
</tr>
</tbody>
</table>
| A | B | |
| 1 | text | value |
| 2 | other |
Returns: Node
loadSpreadsheetData
▸ loadSpreadsheetData(): Promise‹GoogleJsonSpreadsheet›
Defined in spreadsheetReader.ts:105
Load spreadsheet data
Returns: Promise‹GoogleJsonSpreadsheet›
Protected processSpreadsheets
▸ processSpreadsheets(rawJson: GoogleJsonSpreadsheet): GoogleJsonSpreadsheet
Defined in spreadsheetReader.ts:88
Parameters:
| Name | Type |
|---|---|
rawJson |
GoogleJsonSpreadsheet |
Returns: GoogleJsonSpreadsheet
Static Protected formatColl
▸ formatColl(cells: Array‹SpredsheedCell›, maxColl: string): *Array‹string |
undefined›* |
Defined in spreadsheetReader.ts:220
Parameters:
| Name | Type |
|---|---|
cells |
Array‹SpredsheedCell› |
maxColl |
string |
| Returns: *Array‹string | undefined›* |
Static Protected lettersGenerator
▸ lettersGenerator(maxLetters: string): Generator‹string›
Defined in spreadsheetReader.ts:230
Parameters:
| Name | Type |
|---|---|
maxLetters |
string |
Returns: Generator‹string›
Static Protected numberGenerator
▸ numberGenerator(maxLines: number): Generator‹number›
Defined in spreadsheetReader.ts:236
Parameters:
| Name | Type | Default |
|---|---|---|
maxLines |
number | 100 |
Returns: Generator‹number›