Uitable Properties (GNU Octave (version 9.1.0))

#### 15.3.3.17 Uitable Properties ¶

Properties of `uitable` objects (see uitable):

#### Categories: ¶

Appearance | Callback Execution | Creation/Deletion | Display | Mouse Interaction | Object Identification | Object Position | Parent/Children | Table Data | Table Operation | Text Appearance

#### Appearance ¶

`backgroundcolor`: colorspec, def. 2-by-3 double ¶

  Color of the background of the table specified as a 3-element RBG vector. If `backgroundcolor` has multiple rows, the colors cycle repeatedly if the `"rowstriping"` property is on.

`foregroundcolor`: colorspec, def. `[0 0 0]` ¶

  Color of the data text in this table. See colorspec.

`rowstriping`: `"off"` | {`"on"`} ¶

  Setting to indicate whether the table background color will use different colors for each row. Colors are drawn from the `"backgroundcolor"` property in a repeating pattern.

#### Callback Execution ¶

`busyaction`: `"cancel"` | {`"queue"`} ¶

  Define how Octave handles the execution of this object’s callback properties when it is unable to interrupt another object’s executing callback. This is only relevant when the currently executing callback object has its `interruptible` property set to `"off"`. The `busyaction` property of the interrupting callback object indicates whether the interrupting callback is queued (`"queue"` (default)) or discarded (`"cancel"`). See Callbacks section.

`celleditcallback`: string, def. `[](0x0)` ¶

  A string consisting of a valid Octave expression that will be executed whenever a table cell is edited.

`cellselectioncallback`: string, def. `[](0x0)` ¶

  A string consisting of a valid Octave expression that will be executed whenever a table cell is selected.

`interruptible`: `"off"` | {`"on"`} ¶

  Specify whether this object’s callback functions may be interrupted by other callbacks. By default `interruptible` is `"on"` and callbacks that make use of `drawnow`, `figure`, `waitfor`, `getframe` or `pause` functions are eventually interrupted. See Callbacks section.

`keypressfcn`: string, def. `[](0x0)` ¶

  A string consisting of a valid Octave expression that will be executed whenever a key is pressed in this table object.

`keyreleasefcn`: def. `[](0x0)` ¶

  A string consisting of a valid Octave expression that will be executed whenever a key is released in this table object.

#### Creation/Deletion ¶

`beingdeleted`: {`"off"`} | `"on"` ¶

  Property indicating that a function has initiated deletion of the object. `beingdeleted` is set to true until the object no longer exists.

`createfcn`: string | function handle, def. `[](0x0)` ¶

  Callback function executed immediately after uitable has been created. Function is set by using default property on root object, e.g., `set (groot, "defaultuitablecreatefcn", 'disp ("uitable created!")')`.

  For information on how to write graphics listener functions see Callbacks section.

`deletefcn`: string | function handle, def. `[](0x0)` ¶

  Callback function executed immediately before uitable is deleted.

  For information on how to write graphics listener functions see Callbacks section.

#### Display ¶

`clipping`: `"off"` | {`"on"`} ¶

  If `clipping` is `"on"`, the uitable is clipped in its parent axes limits.

`visible`: `"off"` | {`"on"`} ¶

  If `visible` is `"off"`, the uitable is not rendered on screen.

#### Mouse Interaction ¶

`buttondownfcn`: string | function handle, def. `[](0x0)` ¶

  For information on how to write graphics listener functions see Callbacks section.

`contextmenu`: graphics handle, def. `[](0x0)` ¶

  Graphics handle of the uicontextmenu object that is currently associated to this uitable object.

`hittest`: `"off"` | {`"on"`} ¶

  Specify whether uitable processes mouse events or passes them to ancestors of the object. When enabled, the object may respond to mouse clicks by evaluating the `"buttondownfcn"`, showing the uicontextmenu, and eventually becoming the root `"currentobject"`. This property is only relevant when the object can accept mouse clicks which is determined by the `"pickableparts"` property. See pickableparts property.

`pickableparts`: `"all"` | `"none"` | {`"visible"`} ¶

  Specify whether uitable will accept mouse clicks. By default, `pickableparts` is `"visible"` and only visible parts of the uitable or its children may react to mouse clicks. When `pickableparts` is `"all"` both visible and invisible parts (or children) may react to mouse clicks. When `pickableparts` is `"none"` mouse clicks on the object are ignored and transmitted to any objects underneath this one. When an object is configured to accept mouse clicks the `"hittest"` property will determine how they are processed. See hittest property.

`selected`: {`"off"`} | `"on"` ¶

  Property indicates whether this uitable is selected.

`selectionhighlight`: `"off"` | {`"on"`} ¶

  If `selectionhighlight` is `"on"`, then the uitable’s selection state is visually highlighted.

`tooltipstring`: string, def. `""` ¶

  A text string that appears in a tooltip when the mouse pointer hovers over the table object.

#### Object Identification ¶

`tag`: string, def. `""` ¶

  A user-defined string to label the graphics object.

`type` (read-only): string ¶

  Class name of the graphics object. `type` is always `"uitable"`.

`userdata`: Any Octave data, def. `[](0x0)` ¶

  User-defined data to associate with the graphics object.

#### Object Position ¶

`extent` (read-only): four-element vector ¶

  A for element vector indicating the size of the table. The first two elements of the array are always zero, while the third and fourth elements contain the height and width of the table.

`position`: four-element vector, def. `[20 20 300 300]` ¶

  The position and size of the table. The four elements of the vector are the coordinates of the lower left corner and width and height of the figure. See units property.

`units`: `"centimeters"` | `"characters"` | `"inches"` | `"normalized"` | {`"pixels"`} | `"points"` ¶

  Unit of measurement used to interpret the `"position"` property.

#### Parent/Children ¶

`children` (read-only): vector of graphics handles, def. `[](0x1)` ¶

  Graphics handles of the uitable’s children.

`handlevisibility`: `"callback"` | `"off"` | {`"on"`} ¶

  If `handlevisibility` is `"off"`, the uitable’s handle is not visible in its parent’s `"children"` property.

`parent`: graphics handle ¶

  Handle of the parent graphics object.

#### Table Data ¶

`columnformat`: def. `{}(0x0)` ¶

  The display format for numeric data in each column. Valid formats include `"char"`, `"logical"`, `"numeric"`, or a valid format setting from the format function

`columnname`: def. `"numbered"` ¶

  Column names specified as either `"numbered"` or a 1 x N cell string vector containing the names to be used for each column heading.

`columnwidth`: def. `"auto"` ¶

  Setting for determining width of each column, valid options include: `"auto"`, `"fit"`, evenly divided multiples specified as `"1x"`, `"2x"`, etc., or a 1 x N cell vector where each element corresponds to one of N table columns, and containing any of the above options or a fixed width specified in pixels.

`data`: matrix, def. `[](0x0)` ¶

  The data contained in the table specified as either a 2-D numeric, logical, or cell array.

`rowname`: def. `"numbered"` ¶

  Row names specified as either `"numbered"` or a N x 1 cell string vector containing the names to be used for each row heading.

#### Table Operation ¶

`columneditable`: logical row vector, def. `[](0x0)` ¶

  A logical indicator of whether the columns are editable. It consists of either a 1 x N vector of logical values where true or false indicate the corresponding column is or is not editable, respectively, or an empty logical array indicating that no column is editable.

`enable`: `"off"` | {`"on"`} ¶

  Sets whether this table object is active or is grayed out.

`rearrangeablecolumns`: {`"off"`} | `"on"` ¶

  Indicates whether or not the ability to move columns by clicking and dragging the column headers.

#### Text Appearance ¶

`fontangle`: `"italic"` | {`"normal"`} ¶

  Control whether the font is italic or normal.

`fontname`: string, def. `"*"` ¶

  Name of font used for text rendering. When setting this property, the text rendering engine will search for a matching font in your system. If none is found then text is rendered using a default sans serif font (same as the default `"*"` value).

  Programming Note: On systems that don’t use FontConfig natively (all but Linux), the font cache is built when Octave is installed. You will need to run `system ("fc-cache -fv")` manually after installing new fonts.

`fontsize`: scalar, def. `10` ¶

  Size of the font used for text rendering. See fontunits property.

`fontunits`: `"centimeters"` | `"inches"` | `"normalized"` | `"pixels"` | {`"points"`} ¶

  Units used to interpret the `"fontsize"` property.

`fontweight`: `"bold"` | {`"normal"`} ¶

  Control the variant of the base font used for text rendering.