interface MicrosoftExcelV2NodeParameters {
additionalFields?: { name?: string };
applyTo?: "All" | "Formats" | "Contents";
columnToMatchOn?: string;
data?: string;
dataMode?: "define" | "raw" | "autoMap";
dataProperty?: string;
dataStartRow?: number;
fieldsUi?: {
values: { column?: string; fieldValue?: string }[];
};
filters?: | { fields?: string }
| { column?: unknown[]; fields?: string };
hasHeaders?: boolean;
keyRow?: number;
limit?: number;
lookupColumn?: string;
lookupValue?: string;
operation?:
| "getAll"
| "update"
| "append"
| "upsert"
| "lookup"
| "clear"
| "addWorksheet"
| "getColumns"
| "getRows"
| "convertToRange"
| "addTable"
| "deleteTable"
| "deleteWorkbook"
| "deleteWorksheet"
| "readRows";
options?: | {
dataProperty: string;
index?: number;
rawData?: boolean;
}
| { returnAllMatches?: boolean }
| { dataProperty: string; rawData?: boolean }
| {
dataProperty: string;
fields?: string;
rawData?: boolean;
}
| {
dataProperty: string;
fields?: string;
rawData?: boolean;
updateAll?: boolean;
}
| {
appendAfterSelectedRange?: boolean;
dataProperty: string;
rawData?: boolean;
updateAll?: boolean;
};
range?: string;
rawData?: boolean;
resource?: "table"
| "workbook"
| "worksheet";
returnAll?: boolean;
selectRange?: "auto" | "manual";
table?: { mode: "id" | "list"; value: string };
useRange?: boolean;
valueToMatchOn?: string;
workbook?: { mode: "id" | "list"; value: string };
worksheet?: { mode: "id" | "list"; value: string };
}
Properties§
Source§readonly column To Match On?: string
readonly column To Match On?: string
Choose from the list, or specify an ID using an expression Type options: {"loadOptionsDependsOn":["worksheet.value","workbook.value","range"],"loadOptionsMethod":"getWorksheetColumnRow"}
Source§readonly data?: string
readonly data?: string
Raw values for the specified range as array of string arrays in JSON format
Source§readonly data Property?: string
readonly data Property?: string
The name of the property into which to write the RAW data Default: "data"
Source§readonly data Start Row?: number
readonly data Start Row?: number
Relative to selected 'Range', first row index is 0 Default: 1 Type options: {"minValue":0}
Source§readonly fields Ui?: { values: { column?: string; fieldValue?: string }[] }
readonly fields Ui?: { values: { column?: string; fieldValue?: string }[] }
Default: {} Type options: {"multipleValues":true}
Source§readonly filters?:
| { fields?: string }
| { column?: unknown[]; fields?: string }
readonly filters?:
| { fields?: string }
| { column?: unknown[]; fields?: string }
Default: {}
Source§readonly has Headers?: boolean
readonly has Headers?: boolean
Whether the range has column labels. When this property set to false Excel will automatically generate header shifting the data down by one row. Default: true
Source§readonly key Row?: number
readonly key Row?: number
Relative to selected 'Range', first row index is 0 Type options: {"minValue":0}
Source§readonly limit?: number
readonly limit?: number
Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":500}
Source§readonly operation?:
| "getAll"
| "update"
| "append"
| "upsert"
| "lookup"
| "clear"
| "addWorksheet"
| "getColumns"
| "getRows"
| "convertToRange"
| "addTable"
| "deleteTable"
| "deleteWorkbook"
| "deleteWorksheet"
| "readRows"
readonly operation?:
| "getAll"
| "update"
| "append"
| "upsert"
| "lookup"
| "clear"
| "addWorksheet"
| "getColumns"
| "getRows"
| "convertToRange"
| "addTable"
| "deleteTable"
| "deleteWorkbook"
| "deleteWorksheet"
| "readRows"
Default: "append"
Source§readonly options?:
| {
dataProperty: string;
index?: number;
rawData?: boolean;
}
| { returnAllMatches?: boolean }
| { dataProperty: string; rawData?: boolean }
| {
dataProperty: string;
fields?: string;
rawData?: boolean;
}
| {
dataProperty: string;
fields?: string;
rawData?: boolean;
updateAll?: boolean;
}
| {
appendAfterSelectedRange?: boolean;
dataProperty: string;
rawData?: boolean;
updateAll?: boolean;
}
readonly options?:
| {
dataProperty: string;
index?: number;
rawData?: boolean;
}
| { returnAllMatches?: boolean }
| { dataProperty: string; rawData?: boolean }
| {
dataProperty: string;
fields?: string;
rawData?: boolean;
}
| {
dataProperty: string;
fields?: string;
rawData?: boolean;
updateAll?: boolean;
}
| {
appendAfterSelectedRange?: boolean;
dataProperty: string;
rawData?: boolean;
updateAll?: boolean;
}
Default: {}
Source§readonly raw Data?: boolean
readonly raw Data?: boolean
Whether the data should be returned RAW instead of parsed into keys according to their header
Default: {}