lv_line.h

API reference for lv_line.h

Summary

Functions

public/widgets/lv_line.h:59function

lv_line_set_points

Set an array of points. The line object will connect these points.

void lv_line_set_points(lv_obj_t *obj, const lv_point_precise_t points[], uint32_t point_num)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a line object
`points`	`const lv_point_precise_t`	an array of points. Only the address is saved, so the array needs to be alive while the line exists. May be `NULL`. Use NULL to remove the previously assigned points of the line
`point_num`	`uint32_t`	number of points in 'point_a'

public/widgets/lv_line.h:68function

lv_line_set_points_mutable

Set a non-const array of points. Identical to lv_line_set_points except the array may be retrieved by lv_line_get_points_mutable.

void lv_line_set_points_mutable(lv_obj_t *obj, lv_point_precise_t points[], uint32_t point_num)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a line object
`points`	`lv_point_precise_t`	a non-const array of points. Only the address is saved, so the array needs to be alive while the line exists. May be `NULL`. Use NULL to remove the previously assigned points of the line
`point_num`	`uint32_t`	number of points in 'point_a'

public/widgets/lv_line.h:77function

lv_line_set_y_invert

Enable (or disable) the y coordinate inversion. If enabled then y will be subtracted from the height of the object, therefore the y = 0 coordinate will be on the bottom.

void lv_line_set_y_invert(lv_obj_t *obj, bool en)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a line object
`en`	`bool`	true: enable the y inversion, false:disable the y inversion

public/widgets/lv_line.h:88function

lv_line_get_points

Get the pointer to the array of points.

const lv_point_precise_t * lv_line_get_points(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a line object

Returns: const lv_point_precise_t * — const pointer to the array of points

public/widgets/lv_line.h:95function

lv_line_get_point_count

Get the number of points in the array of points.

uint32_t lv_line_get_point_count(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a line object

Returns: uint32_t — number of points in array of points

public/widgets/lv_line.h:109function

lv_line_get_points_mutable

Get a pointer to the mutable array of points or NULL if it is not mutable

lv_point_precise_t * lv_line_get_points_mutable(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a line object

Returns: lv_point_precise_t * — pointer to the array of points. NULL if not mutable.

public/widgets/lv_line.h:116function

lv_line_get_y_invert

Get the y inversion attribute

bool lv_line_get_y_invert(const lv_obj_t *obj)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to a line object

Returns: bool — true: y inversion is enabled, false: disabled

public/widgets/lv_line.h:46function

lv_line_create

Create a line object

lv_obj_t * lv_line_create(lv_obj_t *parent)

Name	Type	Description
`parent`	`lv_obj_t *`	pointer to a parent widget May be `NULL`.. When NULL, the widget is created as a screen on the default display.

Returns: lv_obj_t * — pointer to the created line

public/widgets/lv_line.h:102function

lv_line_is_point_array_mutable

Check the mutability of the stored point array pointer.

bool lv_line_is_point_array_mutable(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a line object

Returns: bool — true: the point array pointer is mutable, false: constant

Enums

public/widgets/lv_line.h:30enum

_lv_property_line_id_t

Name	Value
`LV_PROPERTY_LINE_Y_INVERT`	`(LV_PROPERTY_LINE_START + ((int) 0 )) \| (( 11 ) << 28 )`
`LV_PROPERTY_LINE_END`

Variables

public/widgets/lv_line.h:27variable

lv_line_class

const lv_obj_class_t lv_line_class