Skip to content

UpdateCell.md

Latest commit

 

History

History
76 lines (54 loc) · 2.47 KB

UpdateCell.md

File metadata and controls

76 lines (54 loc) · 2.47 KB
Raw

Update cell

Update cell

Overview

Updates a cell value in a data table at the specified row and column position. Returns an independent copy of the table with the updated cell; the original table remains unchanged.

Parameters

1. inputTable (VARIABLE)

  • Label: Base table
  • Description: The table containing the cell to be updated.
  • Required: Yes
  • Default: None
  • Constraints: Variable type: Table

2. selectMethod (SELECT)

  • Label: Select column by
  • Description: Column whose value is to be updated.
  • Required: Yes
  • Default: NAME
  • Constraints: None
  • Options:
    • NAME (label "Header"): Identify the column by its header name.
    • INDEX (label "Index"): Identify the column by its numeric index.

2.1.1 colName (TEXT) (applicable when selectMethod is NAME)

  • Label: Column header
  • Description: The header name of the column containing the cell to update.
  • Required: Yes
  • Default: None
  • Constraints: None

2.1.2 caseSensitive (BOOLEAN) (applicable when selectMethod is NAME)

  • Label: Case-sensitive comparison
  • Description: Controls whether column name comparison should be case-sensitive. When false (default): Case-insensitive (e.g., 'Name' matches 'name', 'NAME'). When true: Case-sensitive (e.g., 'Name' does not match 'name').
  • Required: Yes
  • Default: false
  • Constraints: None

2.2.1 colIndex (NUMBER) (applicable when selectMethod is INDEX)

  • Label: Column index
  • Description: Index numbers start with 0. For example, first column has an index of 0.
  • Required: Yes
  • Default: None
  • Constraints: Must be greater than or equal to 0; must be an integer

3. rowIndex (NUMBER)

  • Label: Row index
  • Description: Index numbers start with 0. For example, first row has an index of 0.
  • Required: Yes
  • Default: None
  • Constraints: Must be greater than or equal to 0; must be an integer

4. newValue (VARIABLE)

  • Label: New value of cell
  • Description: The new value to set at the specified row and column position.
  • Required: Yes
  • Default: None
  • Constraints: None

Output

Returns a TABLE containing an independent copy of the table with the updated cell value.

Exceptions

Throws BotCommandException when the column is not found, the row index is out of range, or on any other internal failure.