lv_chart.h

Go to the documentation of this file.

#ifndef LV_CHART_H
#define LV_CHART_H

#ifdef __cplusplus
extern "C" {
#endif

/*********************
 *      INCLUDES
 *********************/
#ifdef LV_CONF_INCLUDE_SIMPLE
#include "lv_conf.h"
#else
#include "../../../lv_conf.h"
#endif

#if LV_USE_CHART != 0

#include "../lv_core/lv_obj.h"
#include "lv_line.h"

/*********************
 *      DEFINES
 *********************/

#define LV_CHART_POINT_DEF (LV_COORD_MIN)

#define LV_CHART_TICK_LENGTH_AUTO 255

/**********************
 *      TYPEDEFS
 **********************/

enum {
    LV_CHART_TYPE_NONE           = 0x00, 
    LV_CHART_TYPE_LINE          = 0x01, 
    LV_CHART_TYPE_COLUMN        = 0x02, 
    LV_CHART_TYPE_POINT         = 0x04, 
    LV_CHART_TYPE_VERTICAL_LINE = 0x08, 
    LV_CHART_TYPE_AREA          = 0x10, 
};
typedef uint8_t lv_chart_type_t;

enum {
    LV_CHART_UPDATE_MODE_SHIFT,     
    LV_CHART_UPDATE_MODE_CIRCULAR,  
};
typedef uint8_t lv_chart_update_mode_t;

typedef struct
{
    lv_coord_t * points;
    lv_color_t color;
    uint16_t start_point;
} lv_chart_series_t;

enum {
    LV_CHART_AXIS_SKIP_LAST_TICK = 0x00,    
    LV_CHART_AXIS_DRAW_LAST_TICK = 0x01     
};
typedef uint8_t lv_chart_axis_options_t;

typedef struct
{
    const char * list_of_values;
    lv_chart_axis_options_t options;
    uint8_t num_tick_marks;
    uint8_t major_tick_len;
    uint8_t minor_tick_len;
} lv_chart_axis_cfg_t;

/*Data of chart */
typedef struct
{
    /*No inherited ext*/ /*Ext. of ancestor*/
    /*New data for this type */
    lv_ll_t series_ll;    /*Linked list for the data line pointers (stores lv_chart_dl_t)*/
    lv_coord_t ymin;      /*y min value (used to scale the data)*/
    lv_coord_t ymax;      /*y max value (used to scale the data)*/
    uint8_t hdiv_cnt;     /*Number of horizontal division lines*/
    uint8_t vdiv_cnt;     /*Number of vertical division lines*/
    uint16_t point_cnt;   /*Point number in a data line*/
    lv_chart_type_t type; /*Line, column or point chart (from 'lv_chart_type_t')*/
    lv_chart_axis_cfg_t y_axis;
    lv_chart_axis_cfg_t x_axis;
    uint16_t margin;
    uint8_t update_mode : 1;
    struct
    {
        lv_coord_t width; /*Line width or point radius*/
        uint8_t num;      /*Number of data lines in dl_ll*/
        lv_opa_t opa;     /*Opacity of data lines*/
        lv_opa_t dark;    /*Dark level of the point/column bottoms*/
    } series;
} lv_chart_ext_t;

enum {
    LV_CHART_STYLE_MAIN,
};
typedef uint8_t lv_chart_style_t;

/**********************
 * GLOBAL PROTOTYPES
 **********************/

lv_obj_t * lv_chart_create(lv_obj_t * par, const lv_obj_t * copy);

/*======================
 * Add/remove functions
 *=====================*/

lv_chart_series_t * lv_chart_add_series(lv_obj_t * chart, lv_color_t color);

void lv_chart_clear_serie(lv_obj_t * chart, lv_chart_series_t * serie);

/*=====================
 * Setter functions
 *====================*/

void lv_chart_set_div_line_count(lv_obj_t * chart, uint8_t hdiv, uint8_t vdiv);

void lv_chart_set_range(lv_obj_t * chart, lv_coord_t ymin, lv_coord_t ymax);

void lv_chart_set_type(lv_obj_t * chart, lv_chart_type_t type);

void lv_chart_set_point_count(lv_obj_t * chart, uint16_t point_cnt);

void lv_chart_set_series_opa(lv_obj_t * chart, lv_opa_t opa);

void lv_chart_set_series_width(lv_obj_t * chart, lv_coord_t width);

void lv_chart_set_series_darking(lv_obj_t * chart, lv_opa_t dark_eff);

void lv_chart_init_points(lv_obj_t * chart, lv_chart_series_t * ser, lv_coord_t y);

void lv_chart_set_points(lv_obj_t * chart, lv_chart_series_t * ser, lv_coord_t y_array[]);

void lv_chart_set_next(lv_obj_t * chart, lv_chart_series_t * ser, lv_coord_t y);

void lv_chart_set_update_mode(lv_obj_t * chart, lv_chart_update_mode_t update_mode);

static inline void lv_chart_set_style(lv_obj_t * chart, lv_chart_style_t type, const lv_style_t * style)
{
    (void)type; /*Unused*/
    lv_obj_set_style(chart, style);
}

void lv_chart_set_x_tick_length(lv_obj_t * chart, uint8_t major_tick_len, uint8_t minor_tick_len);

void lv_chart_set_y_tick_length(lv_obj_t * chart, uint8_t major_tick_len, uint8_t minor_tick_len);

void lv_chart_set_x_tick_texts(lv_obj_t * chart, const char * list_of_values, uint8_t num_tick_marks,
                               lv_chart_axis_options_t options);

void lv_chart_set_y_tick_texts(lv_obj_t * chart, const char * list_of_values, uint8_t num_tick_marks,
                               lv_chart_axis_options_t options);

void lv_chart_set_margin(lv_obj_t * chart, uint16_t margin);

/*=====================
 * Getter functions
 *====================*/

lv_chart_type_t lv_chart_get_type(const lv_obj_t * chart);

uint16_t lv_chart_get_point_cnt(const lv_obj_t * chart);

lv_opa_t lv_chart_get_series_opa(const lv_obj_t * chart);

lv_coord_t lv_chart_get_series_width(const lv_obj_t * chart);

lv_opa_t lv_chart_get_series_darking(const lv_obj_t * chart);

static inline const lv_style_t * lv_chart_get_style(const lv_obj_t * chart, lv_chart_style_t type)
{
    (void)type; /*Unused*/
    return lv_obj_get_style(chart);
}

uint16_t lv_chart_get_margin(lv_obj_t * chart);

/*=====================
 * Other functions
 *====================*/

void lv_chart_refresh(lv_obj_t * chart);

/**********************
 *      MACROS
 **********************/

#endif /*LV_USE_CHART*/

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /*LV_CHART_H*/