1.6 KiB
.. include:: /header.rst
:github_url: |github_link_base|/widgets/line.md
Line (lv_line)
Overview
The Line object is capable of drawing straight lines between a set of points.
Parts and Styles
LV_PART_MAINIt uses all the typical backgrund properties and the line style properties.
Usage
Set points
The points has to be stored in an lv_point_t array and passed to the object by the lv_line_set_points(lines, point_array, point_cnt) function.
Auto-size
By default the Line's width and height is set to LV_SIZE_CONTENT to automatically set its size to involve all the points.
If the size if set explicitly the point out of the object
It can be enable with the lv_line_set_auto_size(line, true) function.
If enabled then when the points are set the object's width and height will be changed according to the maximal x and y coordinates among the points. The auto size is enabled by default.
Invert y
By deafult, the y == 0 point is in the top of the object. It might be conter-intuitive in some cases so the y coordinates can be inverted with lv_line_set_y_invert(line, true). In this case, y == 0 will be the bottom of teh obejct.
The y invert is disabled by default.
Events
Only the Generic events are sent by the object type.
Learn more about Events.
Keys
No Keys are processed by the object type.
Learn more about Keys.
Example
.. include:: ../../../examples/widgets/line/index.rst
API
.. doxygenfile:: lv_line.h
:project: lvgl