Box

方框圖的句柄。

靜態方法

new

創建一個新的盒子對象。

參數

名稱	類型	預設值	說明
left	series int		左座標（bar 索引或 UNIX 時間）。
top	series float		頂部座標（價格）。
right	series int		右座標（bar 索引或 UNIX 時間）。
bottom	series float		底部座標（價格）。
border_color	series color	color.BLUE	框的邊框顏色。
border_width	series int	1	邊框寬度（以像素為單位）。
border_style	series LineStyle	LineStyle.Solid	邊框線樣式。
extend	series Extend	Extend.None	擴展模式：extend.none、extend.left、extend.right或extend.both。
xloc	series Xloc	Xloc.BarIndex	x 位置類型：xloc.bar_index 或 xloc.bar_time。
bgcolor	series color	color.BLUE	框的背景顏色。
text	series string	""	框的文本內容。
text_size	series int	0	文本大小（以像素為單位）。
text_color	series color	color.BLACK	文字顏色。
text_halign	series TextHAlign	TextHAlign.Right	水平文本對齊方式。
text_valign	series TextVAlign	TextVAlign.Center	垂直文本對齊方式。
text_wrap	series TextWrap	TextWrap.None	文本換行模式。
text_font_family	series FontFamily	FontFamily.Default	文本的字體系列。
force_overlay	const bool	false	如果為 true，則該框將呈現在頂部。
text_formatting	const TextFormat	text.NONE	文本格式選項。

返回: series Box

創建一個新的盒子對象。

參數

名稱	類型	預設值	說明
left	series int		左座標（bar 索引或 UNIX 時間）。
top	series float		頂部座標（價格）。
right	series int		右座標（bar 索引或 UNIX 時間）。
bottom	series float		底部座標（價格）。
border_color	series color	color.BLUE	框的邊框顏色。
border_width	series int	1	邊框寬度（以像素為單位）。
border_style	series LineStyle	LineStyle.Solid	邊框線樣式。
extend	series Extend	Extend.None	擴展模式：extend.none、extend.left、extend.right或extend.both。
xloc	series Xloc	Xloc.BarIndex	x 位置類型：xloc.bar_index 或 xloc.bar_time。
bgcolor	series color	color.BLUE	框的背景顏色。
text	series string	""	框的文本內容。
text_size	series Size	Size.Auto	文本大小作為命名常量。
text_color	series color	color.BLACK	文字顏色。
text_halign	series TextHAlign	TextHAlign.Right	水平文本對齊方式。
text_valign	series TextVAlign	TextVAlign.Center	垂直文本對齊方式。
text_wrap	series TextWrap	TextWrap.None	文本換行模式。
text_font_family	series FontFamily	FontFamily.Default	文本的字體系列。
force_overlay	const bool	false	如果為 true，則該框將呈現在頂部。
text_formatting	const TextFormat	text.NONE	文本格式選項。

返回: series Box

創建一個新的盒子對象。

參數

名稱	類型	預設值	說明
top_left	series chart.Point		指定左上角的 chart.point 對象。
bottom_right	series chart.Point		指定右下角的 chart.point 對象。
border_color	series color	color.BLUE	框的邊框顏色。
border_width	series int	1	邊框寬度（以像素為單位）。
border_style	series LineStyle	LineStyle.Solid	邊框線樣式。
extend	series Extend	Extend.None	擴展模式：extend.none、extend.left、extend.right或extend.both。
xloc	series Xloc	Xloc.BarIndex	x 位置類型：xloc.bar_index 或 xloc.bar_time。
bgcolor	series color	color.BLUE	框的背景顏色。
text	series string	""	框的文本內容。
text_size	series Size	Size.Auto	文本大小（以像素為單位）。
text_color	series color	color.BLACK	文字顏色。
text_halign	series TextHAlign	TextHAlign.Right	水平文本對齊方式。
text_valign	series TextVAlign	TextVAlign.Center	垂直文本對齊方式。
text_wrap	series TextWrap	TextWrap.None	文本換行模式。
text_font_family	series FontFamily	FontFamily.Default	文本的字體系列。
force_overlay	const bool	false	如果為 true，則該框將呈現在頂部。
text_formatting	const TextFormat	text.NONE	文本格式選項。

返回: series Box

創建一個新的盒子對象。

參數

名稱	類型	預設值	說明
top_left	series chart.Point		指定左上角的 chart.point 對象。
bottom_right	series chart.Point		指定右下角的 chart.point 對象。
border_color	series color	color.BLUE	框的邊框顏色。
border_width	series int	1	邊框寬度（以像素為單位）。
border_style	series LineStyle	LineStyle.Solid	邊框線樣式。
extend	series Extend	Extend.None	擴展模式：extend.none、extend.left、extend.right或extend.both。
xloc	series Xloc	Xloc.BarIndex	x 位置類型：xloc.bar_index 或 xloc.bar_time。
bgcolor	series color	color.BLUE	框的背景顏色。
text	series string	""	框的文本內容。
text_size	series Size	Size.Auto	文本大小作為命名常量。
text_color	series color	color.BLACK	文字顏色。
text_halign	series TextHAlign	TextHAlign.Right	水平文本對齊方式。
text_valign	series TextVAlign	TextVAlign.Center	垂直文本對齊方式。
text_wrap	series TextWrap	TextWrap.None	文本換行模式。
text_font_family	series FontFamily	FontFamily.Default	文本的字體系列。
force_overlay	const bool	false	如果為 true，則該框將呈現在頂部。
text_formatting	const TextFormat	text.NONE	文本格式選項。

返回: series Box

靜態屬性

all

類型: series Array<Box>

傳回一個陣列，其中填充了腳本繪製的所有當前框。

方法

copy

Box.copy(id: series Box): series Box

創建指定框的複本並傳回其 id。

參數

名稱	類型	預設值	說明
id	series Box		要複製的框。

返回: series Box

---

delete

Box.delete(id: series Box)

從圖表中刪除指定的框。

參數

名稱	類型	預設值	說明
id	series Box		要刪除的框。

---

get_bottom

Box.get_bottom(id: series Box): series float

傳回盒子底部邊框的價格值。

參數

名稱	類型	預設值	說明
id	series Box		從中獲取底部座標的框。

返回: series float

---

get_left

Box.get_left(id: series Box): series int

傳回框左邊框的 bar 索引或 UNIX 時間（取決於用於“xloc”的最後一個值）。

參數

名稱	類型	預設值	說明
id	series Box		從中獲取左座標的框。

返回: series int

---

get_right

Box.get_right(id: series Box): series int

傳回框右邊框的 bar 索引或 UNIX 時間（取決於用於“xloc”的最後一個值）。

參數

名稱	類型	預設值	說明
id	series Box		從中獲取正確座標的框。

返回: series int

---

get_top

Box.get_top(id: series Box): series float

傳回盒子上邊框的價格值。

參數

名稱	類型	預設值	說明
id	series Box		從中獲取頂部座標的框。

返回: series float

---

set_bg_color

Box.set_bg_color(id: series Box, color: series color)

設定框的背景顏色。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
color	series color		新的背景顏色。

---

set_border_color

Box.set_border_color(id: series Box, color: series color)

設定框的邊框顏色。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
color	series color		新的邊框顏色。

---

set_border_style

Box.set_border_style(id: series Box, style: series LineStyle)

設定框的邊框樣式。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
style	series LineStyle		新的邊框線樣式。

---

set_border_width

Box.set_border_width(id: series Box, width: series int)

設定框的邊框寬度。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
width	series int		新的邊框寬度（以像素為單位）。

---

set_bottom

Box.set_bottom(id: series Box, bottom: series float)

設定框的底部座標。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
bottom	series float		新的底部座標（價格）。

---

set_bottom_right_point

Box.set_bottom_right_point(id: series Box, point: series chart.Point)

使用 chart.point 對象設定框的右下角。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
point	series chart.Point		指定新右下角的 chart.point 對象。

---

set_extend

Box.set_extend(id: series Box, extend: series Extend)

設定此框對象邊框的擴展類型。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
extend	series Extend		擴展模式：extend.none、extend.left、extend.right或extend.both。

---

set_left

Box.set_left(id: series Box, left: series int)

設定框的左座標。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
left	series int		新的左座標（bar 索引或 UNIX 時間）。

---

set_lefttop

Box.set_lefttop(id: series Box, left: series int, top: series float)

設定框的左側和頂部座標。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
left	series int		新的左座標（bar 索引或 UNIX 時間）。
top	series float		新的頂部座標（價格）。

---

set_right

Box.set_right(id: series Box, right: series int)

設定框的右座標。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
right	series int		新的右座標（bar 索引或 UNIX 時間）。

---

set_rightbottom

Box.set_rightbottom(id: series Box, right: series int, bottom: series float)

設定框的右側和底部座標。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
right	series int		新的右座標（bar 索引或 UNIX 時間）。
bottom	series float		新的底部座標（價格）。

---

set_text

Box.set_text(id: series Box, text: series string)

設定框的文本大小。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
text	series string		新的文本內容。

---

set_text_color

Box.set_text_color(id: series Box, text_color: series color)

設定框的文本顏色。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
text_color	series color		新的文本顏色。

---

set_text_font_family

Box.set_text_font_family(id: series Box, font_family: series string)

設定框文本的字體系列。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
font_family	series string		字體系列：FontFamily.Default 或 FontFamily.Monospace。

---

set_text_formatting

Box.set_text_formatting(id: series Box, text_formatting: const TextFormat)

設定框的文本格式。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
text_formatting	const TextFormat		文本格式選項。

---

set_text_halign

Box.set_text_halign(id: series Box, text_halign: series TextHAlign)

設定框文本的水平對齊方式。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
text_halign	series TextHAlign		水平文本對齊方式：TextHAlign.Left、TextHAlign.Center 或 TextHAlign.Right。

---

set_text_size

設定框的文本大小。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
text_size	series int		新的文本大小（以像素為單位）。

設定框的文本大小。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
text_size	series Size		新的文本大小作為命名常量（Size.Tiny、Size.Small、Size.Normal、Size.Large、Size.Huge）。

---

set_text_valign

Box.set_text_valign(id: series Box, text_valign: series TextVAlign)

設定框文本的垂直對齊方式。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
text_valign	series TextVAlign		垂直文本對齊方式：text.align_top、TextHAlign.Center 或 text.align_bottom。

---

set_text_wrap

Box.set_text_wrap(id: series Box, text_wrap: series TextWrap)

設定框的文本環繞模式。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
text_wrap	series TextWrap		文本換行模式：text.wrap_none 或 text.wrap_auto。

---

set_top

Box.set_top(id: series Box, top: series float)

設定框的頂部座標。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
top	series float		新的頂部座標（價格）。

---

set_top_left_point

Box.set_top_left_point(id: series Box, point: series chart.Point)

使用 chart.point 對象設定框的左上角。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
point	series chart.Point		指定新左上角的 chart.point 對象。

---

set_xloc

Box.set_xloc(
    id: series Box,
    left: series int,
    right: series int,
    xloc: series Xloc
  )

設定框的左邊框和右邊框並更新其 xloc 屬性。

參數

名稱	類型	預設值	說明
id	series Box		要修改的框。
left	series int		新的左座標（bar 索引或 UNIX 時間）。
right	series int		新的右座標（bar 索引或 UNIX 時間）。
xloc	series Xloc		x 位置類型：xloc.bar_index 或 xloc.bar_time。