模块 lib.graph

图形绘制模块。

灵活的图形绘制,用于波形、点、条形图等。

信息:

  • 版本: v1.1.0
  • 作者: Mark Eats

函数

new (x_min, x_max, x_warp, y_min, y_max, y_warp, style, show_x_axis, show_y_axis) 创建一个新的图形对象。
set_position_and_size (x, y, w, h) 设置图形的位置和大小。
get_x () 获取图形的x位置。
set_x (x) 设置图形的x位置。
get_y () 获取图形的y位置。
set_y (y) 设置图形的y位置。
get_width () 获取图形的宽度。
set_width (w) 设置图形的宽度。
get_height () 获取图形的高度。
set_height (h) 设置图形的高度。
get_x_min () 获取x轴的最小值。
set_x_min (x_min) 设置x轴的最小值。
get_x_max () 获取x轴的最大值。
set_x_max (x_max) 设置x轴的最大值。
get_x_warp () 获取x轴扭曲。
set_x_warp (warp) 设置x轴扭曲。
get_y_min () 获取y轴的最小值。
set_y_min (y_min) 设置y轴的最小值。
get_y_max () 获取y轴的最大值。
set_y_max (y_max) 设置y轴的最大值。
get_y_warp () 获取y轴扭曲。
set_y_warp (warp) 设置y轴扭曲。
get_style () 获取样式。
set_style (style) 设置样式。
get_show_x_axis () 获取显示x轴。
set_show_x_axis (bool) 设置显示x轴。
get_show_y_axis () 获取显示y轴。
set_show_y_axis (bool) 设置显示y轴。
get_active () 获取活动状态。
set_active (bool) 设置活动状态。
get_point (index) 获取索引处的点。
add_point (px, py[, curve[, highlight[, index]]]) 在图形中添加一个点。
edit_point (index[, px[, py[, curve[, highlight]]]]) 编辑索引处的点。
remove_point (index) 移除索引处的点。
remove_all_points () 移除所有点。
highlight_point (index) 高亮索引处的点。
highlight_exclusive_point (index) 独占高亮索引处的点。
clear_highlight (index) 清除索引处点的突出显示。
clear_all_highlights () 清除所有点的突出显示。
get_function (index) 获取索引处的函数。
add_function (func[, sample_quality[, index]]) 在图形中添加一个新的y函数。
edit_function (index, func[, sample_quality]) 编辑索引处的函数。
update_functions () 更新所有函数。
remove_function (index) 移除索引处的函数。
remove_all_functions () 移除所有函数。
redraw () 重绘图形。


函数

new (x_min, x_max, x_warp, y_min, y_max, y_warp, style, show_x_axis, show_y_axis)
创建一个新的图形对象。
所有参数都是可选的。

参数:

  • x_min number x轴的最小值,默认为0。
  • x_max number x轴的最大值,默认为1。
  • x_warp string 定义x轴的扭曲,接受"lin"或"exp",默认为"lin"。
  • y_min number y轴的最小值,默认为0。
  • y_max number y轴的最大值,默认为1。
  • y_warp string 定义y轴的扭曲,接受"lin"或"exp",默认为"lin"。
  • style string 定义视觉样式,接受 "line"、"point"、"spline"、"line_and_point"、"spline_and_point" 或 "bar",默认为 "line"。
  • show_x_axis boolean 如果设置为 true 则显示 x 轴,默认为 false。
  • show_y_axis boolean 如果设置为 true 则显示 y 轴,默认为 false。

返回:

    Graph Graph 实例。
set_position_and_size (x, y, w, h)
设置图形的位置和大小。 所有参数都是可选的。

参数:

  • x number x 位置(像素)。
  • y number y 位置(像素)。
  • w number 宽度(像素)。
  • h number 高度(像素)。
get_x ()
获取图形的x位置。

返回:

    number x 位置。
set_x (x)
设置图形的x位置。

参数:

  • x number x 位置(像素)。
get_y ()
获取图形的y位置。

返回:

    number y 位置。
set_y (y)
设置图形的y位置。

参数:

  • y number y 位置(像素)。
get_width ()
获取图形的宽度。

返回:

    number 宽度。
set_width (w)
设置图形的宽度。

参数:

  • w number 宽度(像素)。
get_height ()
获取图形的高度。

返回:

    number 高度。
set_height (h)
设置图形的高度。

参数:

  • h number 高度(像素)。
get_x_min ()
获取x轴的最小值。

返回:

    number x轴的最小值。
set_x_min (x_min)
设置x轴的最小值。

参数:

  • x_min number x轴的最小值。
get_x_max ()
获取x轴的最大值。

返回:

    number x轴的最大值。
set_x_max (x_max)
设置x轴的最大值。

参数:

  • x_max number x轴的最大值。
get_x_warp ()
获取x轴扭曲。

返回:

    string x轴扭曲字符串。
set_x_warp (warp)
设置x轴扭曲。

参数:

  • warp string 扭曲字符串,接受 "lin" 或 "exp"。
get_y_min ()
获取y轴的最小值。

返回:

    number y轴的最小值。
set_y_min (y_min)
设置y轴的最小值。

参数:

  • y_min number y轴的最小值。
get_y_max ()
获取y轴的最大值。

返回:

    number y轴的最大值。
set_y_max (y_max)
设置y轴的最大值。

参数:

  • y_max number y轴的最大值。
get_y_warp ()
获取y轴扭曲。

返回:

    string y轴扭曲字符串。
set_y_warp (warp)
设置y轴扭曲。

参数:

  • warp string 扭曲字符串,接受 "lin" 或 "exp"。
get_style ()
获取样式。

返回:

    string 样式字符串。
set_style (style)
设置样式。

参数:

  • style string 样式字符串,接受 "line"、"point"、"spline"、"line_and_point"、"spline_and_point" 或 "bar"。
get_show_x_axis ()
获取显示x轴状态。

返回:

    boolean 显示x轴的布尔值。
set_show_x_axis (bool)
设置显示x轴。

参数:

  • bool boolean 如果设置为true则显示x轴。
get_show_y_axis ()
获取显示y轴状态。

返回:

    显示y轴的布尔值。
set_show_y_axis (bool)
设置显示y轴。

参数:

  • bool boolean 如果设置为true则显示y轴。
get_active ()
获取活动状态。

返回:

    boolean 活动状态布尔值。
set_active (bool)
设置活动状态。

参数:

  • bool boolean 当设置为false时会使图形外观变暗。
get_point (index)
获取指定索引处的点。

参数:

  • index 点的索引。

返回:

    table 点数据表。
add_point (px, py[, curve[, highlight[, index]]])
在图形中添加一个点。

参数:

  • px number 点的x位置。
  • py number 点的y位置。
  • curve string or number 前一线段的曲线,接受"lin"、"exp"或数字,其中0为线性,正负数字使包络向上或向下弯曲,默认为"lin"。 (optional)
  • highlight boolean 如果设置为true则高亮点,默认为false。 (optional)
  • index number 添加点的索引位置,默认为列表末尾。 (optional)
edit_point (index[, px[, py[, curve[, highlight]]]])
编辑指定索引处的点。

参数:

  • index number 要编辑的点的索引。
  • px number 点的x位置。 (optional)
  • py number 点的y位置。 (optional)
  • curve string or number 前一线段的曲线,接受"lin"、"exp"或数字,其中0为线性,正负数字使包络向上或向下弯曲。 (optional)
  • highlight boolean 如果设置为true则高亮点。 (optional)
remove_point (index)
移除指定索引处的点。 移除点后,后续索引将会改变。

参数:

  • index 要移除的点的索引。
remove_all_points ()
移除所有点。
highlight_point (index)
高亮指定索引处的点。

参数:

  • index 要高亮的点的索引。
highlight_exclusive_point (index)
独占高亮指定索引处的点。 其他点的高亮状态将被设置为false。

参数:

  • index 要高亮的点的索引。
clear_highlight (index)
清除指定索引处点的高亮。

参数:

  • index 要清除高亮的点的索引。
clear_all_highlights ()
清除所有点的高亮。
get_function (index)
获取指定索引处的函数。

参数:

  • index 函数的索引。

返回:

    function 函数。
add_function (func[, sample_quality[, index]])
在图形中添加一个新的y函数。 添加一个用于生成线条的函数。

参数:

  • func function 一个应该为任何给定的x值返回y值的函数。例如,'function(x) return math.sin(x) end'
  • sample_quality number 图形函数的采样质量。小于1的值将少于每像素一次采样,大于1的值可以帮助减少高频变化图形的抖动,但会降低性能。推荐范围0.25到4,默认为1。 (optional)
  • index 添加函数的索引位置,默认为列表末尾。 (optional)
edit_function (index, func[, sample_quality])
编辑指定索引处的函数。

参数:

  • index 要编辑的函数的索引。
  • func function 一个应该为任何给定的x值返回y值的函数。
  • sample_quality number 图形函数的采样质量,默认为1。 (optional)
update_functions ()
更新所有函数。 当函数的输出发生变化时调用以重绘其线条。
remove_function (index)
移除指定索引处的函数。 移除函数后,后续索引将会改变。

参数:

  • index 要移除的函数的索引。
remove_all_functions ()
移除所有函数。
redraw ()
重绘图形。 当图形数据或设置发生变化时调用。
由 LDoc 1.5.0 生成 最后更新于 2025-04-06 15:35:25