nodes/generated

Interface MicrosoftExcelSharePointNodeParameters

Source


interface MicrosoftExcelSharePointNodeParameters {
    applyTo?: "All" | "Formats" | "Contents";
    authentication?:
        | "microsoftEntraServicePrincipalApi"
        | "microsoftOAuth2Api";
    columnToMatchOn?: string;
    data?: string;
    dataMode?: "define"
    | "raw"
    | "autoMap";
    dataProperty?: string;
    dataStartRow?: number;
    fieldsUi?: {
        values: { column?: string; fieldValue?: string }[];
    };
    filter?: string;
    hasHeaders?: boolean;
    keyRow?: number;
    library?: { mode: "id"
    | "list"; value: string };
    limit?: number;
    lookupColumn?: string;
    lookupValue?: string;
    operation?:
        | "create"
        | "getAll"
        | "update"
        | "append"
        | "upsert"
        | "clear"
        | "deleteTable"
        | "lookup"
        | "deleteWorksheet"
        | "readRows"
        | "convertToRange"
        | "getColumns"
        | "getRows"
        | "addWorksheet"
        | "deleteWorkbook";
    options?: | { dataProperty: string; rawData?: boolean }
    | {
        dataProperty: string;
        fields?: string;
        rawData?: boolean;
    }
    | { fields?: string }
    | {
        dataProperty: string;
        fields?: string;
        rawData?: boolean;
        updateAll?: boolean;
    }
    | {
        appendAfterSelectedRange?: boolean;
        dataProperty: string;
        rawData?: boolean;
        updateAll?: boolean;
    }
    | { returnAllMatches?: boolean }
    | {
        dataProperty: string;
        index?: number;
        rawData?: boolean;
    }
    | { name?: string };
    range?: string;
    rawData?: boolean;
    resource?: "table" | "worksheet" | "workbook";
    returnAll?: boolean;
    selectRange?: "manual" | "auto";
    site?: { mode: "id" | "list" | "url"; value: string };
    table?: { mode: "id" | "list"; value: string };
    useRange?: boolean;
    valueToMatchOn?: string;
    workbook?: {
        mode: "id" | "list" | "url";
        value: string;
    };
    worksheet?: { mode: "id"
    | "list"; value: string };
}

Properties§

§readonly applyTo?: "All" | "Formats" | "Contents"

Default: "All"

§readonly authentication?: "microsoftEntraServicePrincipalApi" | "microsoftOAuth2Api"

Default: "microsoftOAuth2Api"

§readonly columnToMatchOn?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsDependsOn":["worksheet.value","workbook.value","range"],"loadOptionsMethod":"getWorksheetColumnRow"}

§readonly data?: string

Raw values for the specified range as array of string arrays in JSON format

§readonly dataMode?: "define" | "raw" | "autoMap"

Default: "autoMap"

§readonly dataProperty?: string

The name of the property into which to write the RAW data Default: "data"

§readonly dataStartRow?: number

Relative to selected 'Range', first row index is 0 Default: 1 Type options: {"minValue":0}

§readonly fieldsUi?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly filter?: string

Text to search the library for. Leave empty to list every workbook.

§readonly hasHeaders?: 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

§readonly keyRow?: number

Relative to selected 'Range', first row index is 0 Type options: {"minValue":0}

§readonly library?: { ... }

The document library the workbook lives in. Only needed when the workbook is chosen from the list or by ID. Default: {"mode":"list","value":""} Type options: {"loadOptionsDependsOn":["site.value"]}

§readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":500}

§readonly lookupColumn?: string

The name of the column in which to look for value

§readonly lookupValue?: string

The value to look for in column

§readonly operation?:
    | "create"
    | "getAll"
    | "update"
    | "append"
    | "upsert"
    | "clear"
    | "deleteTable"
    | "lookup"
    | "deleteWorksheet"
    | "readRows"
    | "convertToRange"
    | "getColumns"
    | "getRows"
    | "addWorksheet"
    | "deleteWorkbook"

Default: "readRows"

§readonly options?:
    | { dataProperty: string; rawData?: boolean }
    | {
        dataProperty: string;
        fields?: string;
        rawData?: boolean;
    }
    | { fields?: string }
    | {
        dataProperty: string;
        fields?: string;
        rawData?: boolean;
        updateAll?: boolean;
    }
    | {
        appendAfterSelectedRange?: boolean;
        dataProperty: string;
        rawData?: boolean;
        updateAll?: boolean;
    }
    | { returnAllMatches?: boolean }
    | {
        dataProperty: string;
        index?: number;
        rawData?: boolean;
    }
    | { name?: string }

Default: {}

§readonly range?: string

The sheet range that would be cleared, specified using A1-style notation

§readonly rawData?: boolean

Whether the data should be returned RAW instead of parsed into keys according to their header

§readonly resource?: "table" | "worksheet" | "workbook"

Default: "worksheet"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly selectRange?: "manual" | "auto"

Default: "auto"

§readonly site?: { ... }

The SharePoint site the workbook lives in. Only needed when the workbook is chosen from the list or by ID. Default: {"mode":"list","value":""}

§readonly table?: { ... }

Default: {"mode":"list","value":""} Type options: {"loadOptionsDependsOn":["worksheet.value"]}

§readonly useRange?: boolean
§readonly valueToMatchOn?: string
§readonly workbook?: { ... }

Pick the workbook by URL (no site or library needed), from the list, or by ID Default: {"mode":"url","value":""} Type options: {"loadOptionsDependsOn":["site.value","library.value"]}

§readonly worksheet?: { ... }

Default: {"mode":"list","value":""} Type options: {"loadOptionsDependsOn":["workbook.value"]}