QScript ExcelSummaryTable
Jump to navigation
Jump to search
ExcelSummaryTable
Represents an individual table inside an Excel worksheet. An Excel table sits at the bottom of the summary table data source tree (workbook → worksheet → table) and has no further sub-items.
equals(obj)
Whether two objects are the same.
| obj | The object to compare against. |
| Returns: | true or false |
| Example: | data_file.getQuestionByName('Q2').equals(data_file.questions()[0])
|
error
Errors associated with this item as a string. Returns null if there are no errors. Warnings are excluded. Errors only surface on individual tables (Excel tables, SQL tables, summary tables); workbooks, worksheets, queries and SQL connections return null.
guid
Get the internal identifier for this table, which is unique for all items in the document.
name
Get/set the name of this item. Setting is silently ignored for items that do not support a name change.
referenceName
Get/set the reference name for this item, used to refer to it in the source code of other items. Setting is only supported on individual tables (Excel tables, SQL tables, summary tables); on workbooks, worksheets, SQL queries and SQL connections the setter is a silent no-op.
type
Returns ExcelSummaryTable.
worksheet
Gets the worksheet that contains this table.