---
title: "Label"
---
# Label
標籤繪圖的句柄。
## 靜態方法
### new {#new}
在圖表上創建標籤對象。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `point` |
series chart.Point | | 指定標籤位置的
chart.point 對象。 |
| `text` |
series String | `""` | 要在標籤上顯示的文本。 |
| `xloc` |
series XLoc | `XLoc.BarIndex` | x 位置類型：xloc.bar_index 或 xloc.bar_time。 |
| `yloc` |
series YLoc | `YLoc.Price` | y 位置類型：yloc.price 或 yloc.price_range。 |
| `color` |
series Color | `na` | 標籤的背景顏色。 |
| `style` |
series LabelStyle | `LabelStyle.Down` | 標籤的樣式。 |
| `text_color` |
series Color | `na` | 標籤文本的顏色。 |
| `size` |
series Size | `Size.Normal` | 標籤的大小作為命名常量。 |
| `text_align` |
series TextHAlign | `TextHAlign.Center` | 文本對齊方式：TextHAlign.Center、TextHAlign.Left 或 TextHAlign.Right。 |
| `tooltip` |
series String | `na` | 將鼠標懸停在標籤上時的工具提示文本。 |
| `text_font_family` |
series FontFamily | `FontFamily.Default` | 標籤文本的字體系列。 |
| `force_overlay` |
const bool | `false` | 如果為 true，則標籤將呈現在頂部。 |
| `text_formatting` |
const TextFormat | `TextFormat.NONE` | 文本格式選項。 |
**返回:**
series Label
在圖表上創建標籤對象。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `point` |
series chart.Point | | 指定標籤位置的
chart.point 對象。 |
| `text` |
series String | `""` | 要在標籤上顯示的文本。 |
| `xloc` |
series XLoc | `XLoc.BarIndex` | x 位置類型：xloc.bar_index 或 xloc.bar_time。 |
| `yloc` |
series YLoc | `YLoc.Price` | y 位置類型：yloc.price 或 yloc.price_range。 |
| `color` |
series Color | `na` | 標籤的背景顏色。 |
| `style` |
series LabelStyle | `LabelStyle.Down` | 標籤的樣式。 |
| `text_color` |
series Color | `na` | 標籤文本的顏色。 |
| `size` |
series int | `0` | 標籤的大小為整數值。 |
| `text_align` |
series TextHAlign | `TextHAlign.Center` | 文本對齊方式：TextHAlign.Center、TextHAlign.Left 或 TextHAlign.Right。 |
| `tooltip` |
series String | `na` | 將鼠標懸停在標籤上時的工具提示文本。 |
| `text_font_family` |
series FontFamily | `FontFamily.Default` | 標籤文本的字體系列。 |
| `force_overlay` |
const bool | `false` | 如果為 true，則標籤將呈現在頂部。 |
| `text_formatting` |
const TextFormat | `TextFormat.NONE` | 文本格式選項。 |
**返回:**
series Label
在圖表上創建標籤對象。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `x` |
series int | | x 座標（bar 索引或 UNIX 時間）。 |
| `y` |
series float | | y 座標（價格）。 |
| `text` |
series String | `""` | 要在標籤上顯示的文本。 |
| `xloc` |
series XLoc | `XLoc.BarIndex` | x 位置類型：xloc.bar_index 或 xloc.bar_time。 |
| `yloc` |
series YLoc | `YLoc.Price` | y 位置類型：yloc.price 或 yloc.price_range。 |
| `color` |
series Color | `na` | 標籤的背景顏色。 |
| `style` |
series LabelStyle | `LabelStyle.Down` | 標籤的樣式。 |
| `text_color` |
series Color | `na` | 標籤文本的顏色。 |
| `size` |
series Size | `Size.Normal` | 標籤的大小作為命名常量。 |
| `text_align` |
series TextHAlign | `TextHAlign.Center` | 文本對齊方式：TextHAlign.Center、TextHAlign.Left 或 TextHAlign.Right。 |
| `tooltip` |
series String | `na` | 將鼠標懸停在標籤上時的工具提示文本。 |
| `text_font_family` |
series FontFamily | `FontFamily.Default` | 標籤文本的字體系列。 |
| `force_overlay` |
const bool | `false` | 如果為 true，則標籤將呈現在頂部。 |
| `text_formatting` |
const TextFormat | `TextFormat.NONE` | 文本格式選項。 |
**返回:**
series Label
在圖表上創建標籤對象。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `x` |
series int | | x 座標（bar 索引或 UNIX 時間）。 |
| `y` |
series float | | y 座標（價格）。 |
| `text` |
series String | `""` | 要在標籤上顯示的文本。 |
| `xloc` |
series XLoc | `XLoc.BarIndex` | x 位置類型：xloc.bar_index 或 xloc.bar_time。 |
| `yloc` |
series YLoc | `YLoc.Price` | y 位置類型：yloc.price 或 yloc.price_range。 |
| `color` |
series Color | `na` | 標籤的背景顏色。 |
| `style` |
series LabelStyle | `LabelStyle.Down` | 標籤的樣式。 |
| `text_color` |
series Color | `na` | 標籤文本的顏色。 |
| `size` |
series int | `0` | 標籤的大小為整數值。 |
| `text_align` |
series TextHAlign | `TextHAlign.Center` | 文本對齊方式：TextHAlign.Center、TextHAlign.Left 或 TextHAlign.Right。 |
| `tooltip` |
series String | `na` | 將鼠標懸停在標籤上時的工具提示文本。 |
| `text_font_family` |
series FontFamily | `FontFamily.Default` | 標籤文本的字體系列。 |
| `force_overlay` |
series bool | `false` | 如果為 true，則標籤將呈現在頂部。 |
| `text_formatting` |
const TextFormat | `TextFormat.NONE` | 文本格式選項。 |
**返回:**
series Label
series Array<Label>
傳回一個陣列，其中填充了腳本繪製的所有當前標籤。
## 方法
### copy {#copy}
```navi
Label.copy(id: series Label): series Label
```
創建指定標籤的複本並傳回其 id。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 要複製的標籤。 |
**返回:** series Label
---
### delete {#delete}
```navi
Label.delete(id: series Label)
```
從圖表中刪除指定標籤。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 要刪除的標籤。 |
---
### get_text {#get_text}
```navi
Label.get_text(id: series Label): series String
```
傳回此標籤的文本。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 從中獲取文本的標籤。 |
**返回:** series String
---
### get_x {#get_x}
```navi
Label.get_x(id: series Label): series int
```
傳回此標籤位置的 UNIX 時間或 bar 索引（取決於最後設定的 xloc 值）。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 從中獲取 x 座標的標籤。 |
**返回:** series int
---
### get_y {#get_y}
```navi
Label.get_y(id: series Label): series float
```
傳回該標籤位置的價格。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 從中獲取 y 座標的標籤。 |
**返回:** series float
---
### set_color {#set_color}
```navi
Label.set_color(id: series Label, color: series Color)
```
設定此標籤的顏色。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 要修改的標籤。 |
| `color` | series Color | | 新的背景顏色。 |
---
### set_point {#set_point}
```navi
Label.set_point(id: series Label, point: series chart.Point)
```
使用 `chart.point` 對象設定此標籤的位置。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 要修改的標籤。 |
| `point` | series chart.Point | | 指定新位置的 `chart.point` 對象。 |
---
### set_size {#set_size}
設定此標籤的箭頭和文本大小。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` |
series Label | | 要修改的標籤。 |
| `size` |
series int | | 新大小為整數值。 |
設定此標籤的箭頭和文本大小。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` |
series Label | | 要修改的標籤。 |
| `size` |
series Size | | 新大小作為命名常量（Size.Tiny、Size.Small、Size.Normal、Size.Large、Size.Huge）。 |
series Label | | 要修改的標籤。 |
| `style` | series LabelStyle | | 新標籤樣式不變。 |
---
### set_text {#set_text}
```navi
Label.set_text(id: series Label, text: series String)
```
設定此標籤的文本。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 要修改的標籤。 |
| `text` | series String | | 要顯示的新文本。 |
---
### set_text_align {#set_text_align}
```navi
Label.set_text_align(id: series Label, text_align: series TextHAlign)
```
設定此標籤的文本對齊方式。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 要修改的標籤。 |
| `text_align` | series TextHAlign | | 文本對齊方式：TextHAlign.Center、TextHAlign.Left 或 TextHAlign.Right。 |
---
### set_text_color {#set_text_color}
```navi
Label.set_text_color(id: series Label, text_color: series Color)
```
設定此標籤的文本顏色。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 要修改的標籤。 |
| `text_color` | series Color | | 新的文本顏色。 |
---
### set_text_font_family {#set_text_font_family}
```navi
Label.set_text_font_family(
id: series Label,
text_font_family: series FontFamily
)
```
設定此標籤的字體系列。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 要修改的標籤。 |
| `text_font_family` | series FontFamily | | 字體系列：FontFamily.Default 或 FontFamily.Monospace。 |
---
### set_text_formatting {#set_text_formatting}
```navi
Label.set_text_formatting(id: series Label, text_formatting: const TextFormat)
```
設定此標籤的文本格式。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 要修改的標籤。 |
| `text_formatting` | const TextFormat | | 文本格式選項。 |
---
### set_tooltip {#set_tooltip}
```navi
Label.set_tooltip(id: series Label, tooltip: series String)
```
設定此標籤的工具提示文本。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 要修改的標籤。 |
| `tooltip` | series String | | 新的工具提示文本。 |
---
### set_x {#set_x}
```navi
Label.set_x(id: series Label, x: series int)
```
設定此標籤位置的 UNIX 時間或 bar 索引（取決於最後設定的 xloc 值）。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 要修改的標籤。 |
| `x` | series int | | 新的 x 座標（bar 索引或 UNIX 時間）。 |
---
### set_xloc {#set_xloc}
```navi
Label.set_xloc(id: series Label, xloc: series XLoc)
```
設定此標籤的 x 位置類型。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 要修改的標籤。 |
| `xloc` | series XLoc | | x 位置類型：xloc.bar_index 或 xloc.bar_time。 |
---
### set_xy {#set_xy}
```navi
Label.set_xy(id: series Label, x: series int, y: series float)
```
設定此標籤位置的 x 和 y 座標。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 要修改的標籤。 |
| `x` | series int | | 新的 x 座標（bar 索引或 UNIX 時間）。 |
| `y` | series float | | 新的 y 座標（價格）。 |
---
### set_y {#set_y}
```navi
Label.set_y(id: series Label, y: series float)
```
設定該標籤位置的價格。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 要修改的標籤。 |
| `y` | series float | | 新的 y 座標（價格）。 |
---
### set_yloc {#set_yloc}
```navi
Label.set_yloc(id: series Label, yloc: series YLoc)
```
設定此標籤的 y 位置類型。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `id` | series Label | | 要修改的標籤。 |
| `yloc` | series YLoc | | y 位置類型：yloc.price 或 yloc.price_range。 |