nodes/generated

Interface CodaNodeParameters

Source
interface CodaNodeParameters {
    columnId?: string;
    controlId?: string;
    docId?: string;
    formulaId?: string;
    keyName?: string;
    limit?: number;
    operation?:
        | "get"
        | "getAll"
        | "createRow"
        | "deleteRow"
        | "getAllColumns"
        | "getAllRows"
        | "getColumn"
        | "getRow"
        | "pushButton"
        | "deleteViewRow"
        | "getAllViewColumns"
        | "getAllViewRows"
        | "pushViewButton"
        | "updateViewRow";
    options?: | {
        disableParsing?: boolean;
        keyColumns?: string;
    }
    | {
        rawData?: boolean;
        useColumnNames?: boolean;
        valueFormat?: "simple"
        | "simpleWithArrays"
        | "rich";
    }
    | {
        query?: string;
        rawData?: boolean;
        sortBy?: "createdAt"
        | "natural";
        useColumnNames?: boolean;
        valueFormat?: "simple" | "simpleWithArrays" | "rich";
        visibleOnly?: boolean;
    }
    | {
        query?: string;
        rawData?: boolean;
        sortBy?: "createdAt"
        | "natural";
        useColumnNames?: boolean;
        valueFormat?: "simple" | "simpleWithArrays" | "rich";
    }
    | { disableParsing?: boolean };
    resource?: "view" | "control" | "formula" | "table";
    returnAll?: boolean;
    rowId?: string;
    tableId?: string;
    viewId?: string;
}

Properties§

Source§

readonly columnId?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getColumns","loadOptionsDependsOn":["docId","tableId"]}

Source§

readonly controlId?: string

The control to get the row from

Source§

readonly docId?: string

ID of the doc. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getDocs"}

Source§

readonly formulaId?: string

The formula to get the row from

Source§

readonly keyName?: string

The view to get the row from Default: "columns"

Source§

readonly limit?: number

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

Source§

readonly operation?:
    | "get"
    | "getAll"
    | "createRow"
    | "deleteRow"
    | "getAllColumns"
    | "getAllRows"
    | "getColumn"
    | "getRow"
    | "pushButton"
    | "deleteViewRow"
    | "getAllViewColumns"
    | "getAllViewRows"
    | "pushViewButton"
    | "updateViewRow"

Default: "createRow"

Source§

readonly options?:
    | { disableParsing?: boolean; keyColumns?: string }
    | {
        rawData?: boolean;
        useColumnNames?: boolean;
        valueFormat?: "simple" | "simpleWithArrays" | "rich";
    }
    | {
        query?: string;
        rawData?: boolean;
        sortBy?: "createdAt"
        | "natural";
        useColumnNames?: boolean;
        valueFormat?: "simple" | "simpleWithArrays" | "rich";
        visibleOnly?: boolean;
    }
    | {
        query?: string;
        rawData?: boolean;
        sortBy?: "createdAt"
        | "natural";
        useColumnNames?: boolean;
        valueFormat?: "simple" | "simpleWithArrays" | "rich";
    }
    | { disableParsing?: boolean }

Default: {}

Source§

readonly resource?: "view" | "control" | "formula" | "table"

Default: "table"

Source§

readonly returnAll?: boolean

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

Source§

readonly rowId?: string

ID or name of the row. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it. If there are multiple rows with the same value in the identifying column, an arbitrary one will be selected

Source§

readonly tableId?: string

The table to create the row in. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsDependsOn":["docId"],"loadOptionsMethod":"getTables"}

Source§

readonly viewId?: string

The view to get the row from