---
title: "Table"
---
# Table
表格繪圖的句柄。
## 靜態方法
### new {#new}
```navi
Table.new(
position: series Position,
columns: series int,
rows: series int,
bg_color: series Color = na,
frame_color: series Color = na,
frame_width: series int = 0,
border_color: series Color = na,
border_width: series int = 0,
force_overlay: series bool = false
): series Table
```
在圖表上創建一個表格對象。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `position` | series Position | | 表格在圖表上的位置（例如，Position.TopLeft、Position.TopCenter 等）。 |
| `columns` | series int | | 表中的列數。 |
| `rows` | series int | | 表中的行數。 |
| `bg_color` | series Color | `na` | 表格的背景顏色。 |
| `frame_color` | series Color | `na` | 表格的邊框顏色。 |
| `frame_width` | series int | `0` | 框架邊框寬度（以像素為單位）。 |
| `border_color` | series Color | `na` | 表格邊框顏色。 |
| `border_width` | series int | `0` | 表格邊框寬度（以像素為單位）。 |
| `force_overlay` | series bool | `false` | 如果為 true，則表格將呈現在頂部。 |
**返回:** series Table
## 靜態屬性
### all {#all}
**類型:** series Array<Table>
傳回一個陣列，其中填充了腳本繪製的所有當前表。
## 方法
### cell {#cell}
設定表中特定單元格的屬性。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` |
series Table | | 要修改的表對象。 |
| `column` |
series int | | 單元格的列索引（從 0 開始）。 |
| `row` |
series int | | 單元格的行索引（從 0 開始）。 |
| `text` |
series String | `""` | 單元格的文本內容。 |
| `width` |
series float | `0` | 單元格的寬度（以像素為單位）。 |
| `height` |
series float | `0` | 單元格的高度（以像素為單位）。 |
| `text_color` |
series Color | `Color.BLACK` | 文字顏色。 |
| `text_halign` |
series TextHAlign | `TextHAlign.Center` | 水平文本對齊方式。 |
| `text_valign` |
series TextVAlign | `TextVAlign.Center` | 垂直文本對齊方式。 |
| `text_size` |
series int | `14` | 文本大小（以像素為單位）。 |
| `bg_color` |
series Color | `na` | 單元格的背景顏色。 |
| `tooltip` |
series String | `na` | 單元格的工具提示文本。 |
| `text_font_family` |
series FontFamily | `FontFamily.Default` | 文本的字體系列。 |
| `text_formatting` |
const TextFormat | `TextFormat.NONE` | 文本格式選項。 |
設定表中特定單元格的屬性。將文本大小重載為命名常量。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` |
series Table | | 要修改的表對象。 |
| `column` |
series int | | 單元格的列索引（從 0 開始）。 |
| `row` |
series int | | 單元格的行索引（從 0 開始）。 |
| `text` |
series String | `""` | 單元格的文本內容。 |
| `width` |
series float | `0` | 單元格的寬度（以像素為單位）。 |
| `height` |
series float | `0` | 單元格的高度（以像素為單位）。 |
| `text_color` |
series Color | `Color.BLACK` | 文字顏色。 |
| `text_halign` |
series TextHAlign | `TextHAlign.Center` | 水平文本對齊方式。 |
| `text_valign` |
series TextVAlign | `TextVAlign.Center` | 垂直文本對齊方式。 |
| `text_size` |
series Size | `Size.Auto` | 文本大小作為命名常量。 |
| `bg_color` |
series Color | `na` | 單元格的背景顏色。 |
| `tooltip` |
series String | `na` | 單元格的工具提示文本。 |
| `text_font_family` |
series FontFamily | `FontFamily.Default` | 文本的字體系列。 |
| `text_formatting` |
const TextFormat | `TextFormat.NONE` | 文本格式選項。 |
series Table | | 要修改的表對象。 |
| `column` | series int | | 單元格的列索引（從 0 開始）。 |
| `row` | series int | | 單元格的行索引（從 0 開始）。 |
| `bg_color` | series Color | | 單元格的新背景顏色。 |
---
### cell_set_height {#cell_set_height}
```navi
Table.cell_set_height(
table_id: series Table,
column: series int,
row: series int,
height: series float
)
```
設定表格中特定單元格的高度。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` | series Table | | 要修改的表對象。 |
| `column` | series int | | 單元格的列索引（從 0 開始）。 |
| `row` | series int | | 單元格的行索引（從 0 開始）。 |
| `height` | series float | | 單元格的新高度（以像素為單位）。 |
---
### cell_set_text {#cell_set_text}
```navi
Table.cell_set_text(
table_id: series Table,
column: series int,
row: series int,
text: series String
)
```
設定表格中特定單元格的文本。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` | series Table | | 要修改的表對象。 |
| `column` | series int | | 單元格的列索引（從 0 開始）。 |
| `row` | series int | | 單元格的行索引（從 0 開始）。 |
| `text` | series String | | 單元格的新文本內容。 |
---
### cell_set_text_color {#cell_set_text_color}
```navi
Table.cell_set_text_color(
table_id: series Table,
column: series int,
row: series int,
text_color: series Color
)
```
設定表格中特定單元格的文本顏色。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` | series Table | | 要修改的表對象。 |
| `column` | series int | | 單元格的列索引（從 0 開始）。 |
| `row` | series int | | 單元格的行索引（從 0 開始）。 |
| `text_color` | series Color | | 單元格的新文本顏色。 |
---
### cell_set_text_font_family {#cell_set_text_font_family}
```navi
Table.cell_set_text_font_family(
table_id: series Table,
column: series int,
row: series int,
text_font_family: series String
)
```
設定表格中特定單元格中文本的字體系列。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` | series Table | | 要修改的表對象。 |
| `column` | series int | | 單元格的列索引（從 0 開始）。 |
| `row` | series int | | 單元格的行索引（從 0 開始）。 |
| `text_font_family` | series String | | 字體系列：FontFamily.Default 或 FontFamily.Monospace。 |
---
### cell_set_text_formatting {#cell_set_text_formatting}
```navi
Table.cell_set_text_formatting(
table_id: series Table,
column: series int,
row: series int,
text_formatting: const TextFormat
)
```
設定表格中特定單元格中文本的文本格式。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` | series Table | | 要修改的表對象。 |
| `column` | series int | | 單元格的列索引（從 0 開始）。 |
| `row` | series int | | 單元格的行索引（從 0 開始）。 |
| `text_formatting` | const TextFormat | | 文本格式選項。 |
---
### cell_set_text_halign {#cell_set_text_halign}
```navi
Table.cell_set_text_halign(
table_id: series Table,
column: series int,
row: series int,
text_halign: series String
)
```
設定表格中特定單元格中文本的水平對齊方式。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` | series Table | | 要修改的表對象。 |
| `column` | series int | | 單元格的列索引（從 0 開始）。 |
| `row` | series int | | 單元格的行索引（從 0 開始）。 |
| `text_halign` | series String | | 水平文本對齊方式：TextHAlign.Left、TextHAlign.Center 或 TextHAlign.Right。 |
---
### cell_set_text_size {#cell_set_text_size}
設定表格中特定單元格的文本大小。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` |
series Table | | 要修改的表對象。 |
| `column` |
series int | | 單元格的列索引（從 0 開始）。 |
| `row` |
series int | | 單元格的行索引（從 0 開始）。 |
| `text_size` |
series int | | 新的文本大小（以像素為單位）。 |
設定表格中特定單元格的文本大小。使用命名大小常量重載。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` |
series Table | | 要修改的表對象。 |
| `column` |
series int | | 單元格的列索引（從 0 開始）。 |
| `row` |
series int | | 單元格的行索引（從 0 開始）。 |
| `text_size` |
series Size | | 新的文本大小作為命名常量（Size.Tiny、Size.Small、Size.Normal、Size.Large、Size.Huge）。 |
series Table | | 要修改的表對象。 |
| `column` | series int | | 單元格的列索引（從 0 開始）。 |
| `row` | series int | | 單元格的行索引（從 0 開始）。 |
| `text_valign` | series String | | 垂直文本對齊方式：text.align_top、TextHAlign.Center 或 text.align_bottom。 |
---
### cell_set_tooltip {#cell_set_tooltip}
```navi
Table.cell_set_tooltip(
table_id: series Table,
column: series int,
row: series int,
tooltip: series String
)
```
設定表格中特定單元格的工具提示。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` | series Table | | 要修改的表對象。 |
| `column` | series int | | 單元格的列索引（從 0 開始）。 |
| `row` | series int | | 單元格的行索引（從 0 開始）。 |
| `tooltip` | series String | | 單元格的新工具提示文本。 |
---
### cell_set_width {#cell_set_width}
```navi
Table.cell_set_width(
table_id: series Table,
column: series int,
row: series int,
width: series float
)
```
設定表格中特定單元格的寬度。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` | series Table | | 要修改的表對象。 |
| `column` | series int | | 單元格的列索引（從 0 開始）。 |
| `row` | series int | | 單元格的行索引（從 0 開始）。 |
| `width` | series float | | 單元格的新寬度（以像素為單位）。 |
---
### clear {#clear}
```navi
Table.clear(
table_id: series Table,
start_column: series int = 0,
start_row: series int = 0,
end_column: series int = na,
end_row: series int = na
)
```
清除表格中指定單元格範圍的內容。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` | series Table | | 要修改的表。 |
| `start_column` | series int | `0` | 起始列索引。 |
| `start_row` | series int | `0` | 起始行索引。 |
| `end_column` | series int | `na` | 結束列索引。當 na 時，表示最後一列。 |
| `end_row` | series int | `na` | 結束行索引。當 na 時，表示最後一行。 |
---
### delete {#delete}
```navi
Table.delete(table_id: series Table)
```
從圖表中刪除表格。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` | series Table | | 要刪除的表。 |
---
### merge_cells {#merge_cells}
```navi
Table.merge_cells(
table_id: series Table,
start_column: series int = 0,
start_row: series int = 0,
end_column: series int = na,
end_row: series int = na
)
```
合併表格中指定範圍的單元格。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` | series Table | | 要修改的表。 |
| `start_column` | series int | `0` | 起始列索引。 |
| `start_row` | series int | `0` | 起始行索引。 |
| `end_column` | series int | `na` | 結束列索引。當 na 時，表示最後一列。 |
| `end_row` | series int | `na` | 結束行索引。當 na 時，表示最後一行。 |
---
### set_bg_color {#set_bg_color}
```navi
Table.set_bg_color(table_id: series Table, bg_color: series Color)
```
設定表格的背景顏色。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` | series Table | | 要修改的表對象。 |
| `bg_color` | series Color | | 表格的新背景顏色。 |
---
### set_border_color {#set_border_color}
```navi
Table.set_border_color(table_id: series Table, border_color: series Color)
```
設定表格的邊框顏色。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` | series Table | | 要修改的表對象。 |
| `border_color` | series Color | | 表格的新邊框顏色。 |
---
### set_border_width {#set_border_width}
```navi
Table.set_border_width(table_id: series Table, border_width: series int)
```
設定表格的邊框寬度。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` | series Table | | 要修改的表對象。 |
| `border_width` | series int | | 新的邊框寬度（以像素為單位）。 |
---
### set_frame_color {#set_frame_color}
```navi
Table.set_frame_color(table_id: series Table, frame_color: series Color)
```
設定表格的框架顏色。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` | series Table | | 要修改的表對象。 |
| `frame_color` | series Color | | 表格的新框架邊框顏色。 |
---
### set_frame_width {#set_frame_width}
```navi
Table.set_frame_width(table_id: series Table, frame_width: series int)
```
設定表格的框架寬度。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` | series Table | | 要修改的表對象。 |
| `frame_width` | series int | | 新的框架邊框寬度（以像素為單位）。 |
---
### set_position {#set_position}
```navi
Table.set_position(table_id: series Table, position: series Position)
```
設定表格的位置。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `table_id` | series Table | | 要修改的表對象。 |
| `position` | series Position | | 表在圖表上的新位置。 |