github-code/lvgl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(chart) fix typos (#2263)

Browse Source 
Co-authored-by: guowei15 <guowei15@xiaomi.com>
This commit is contained in:
guoweilkd
2021-05-20 20:03:07 +08:00
committed by GitHub
parent fcdca6229f
commit e9d82d8336
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/widgets/extra/chart.md
View File

@@ -17,12 +17,12 @@ Charts also support:
- scrolling and zooming - scrolling and zooming
## Parts and Styles ## Parts and Styles
- `LV_PART_MAIN` The background of the chart. It uses all the typical background related style properties and *line* properties for teh division lines. *Padding* makes the series area smaller. - `LV_PART_MAIN` The background of the chart. It uses all the typical background related style properties and *line* properties for the division lines. *Padding* makes the series area smaller.
- `LV_PART_SCROLLBAR` The scrollbar used if the chart is zoomed. See the [Base object](/widgets/obj)'s documentation for details. - `LV_PART_SCROLLBAR` The scrollbar used if the chart is zoomed. See the [Base object](/widgets/obj)'s documentation for details.
- `LV_PART_ITEMS` Refers to the line or bar series. - `LV_PART_ITEMS` Refers to the line or bar series.
- Line chart: The *line* properties are used by the lines. `width`, `height`, `bg_color` and `radius` is used to set the appearance of points. - Line chart: The *line* properties are used by the lines. `width`, `height`, `bg_color` and `radius` is used to set the appearance of points.
- Bar chart: The typical background properties are used to style the bars. - Bar chart: The typical background properties are used to style the bars.
- `LV_PART_CURSOR` *Line* properties are used to styke the cursors. `width`, `height`, `bg_color` and `radius` is used to set the appearance of points. - `LV_PART_CURSOR` *Line* properties are used to style the cursors. `width`, `height`, `bg_color` and `radius` is used to set the appearance of points.
- `LV_PART_TICKS` *Line* and *Text* style properties are used to style the ticks - `LV_PART_TICKS` *Line* and *Text* style properties are used to style the ticks
## Usage ## Usage
@@ -59,7 +59,7 @@ Use `LV_CHART_POINT_DEF` as value to make the library skip drawing that point, c
### Update modes ### Update modes
`lv_chart_set_next_value` can behave in two ways depending on *update mode*: `lv_chart_set_next_value` can behave in two ways depending on *update mode*:
- `LV_CHART_UPDATE_MODE_SHIFT` Shift old data to the left and add the new one o the right. - `LV_CHART_UPDATE_MODE_SHIFT` Shift old data to the left and add the new one to the right.
- `LV_CHART_UPDATE_MODE_CIRCULAR` - Circularly add the new data (Like an ECG diagram). - `LV_CHART_UPDATE_MODE_CIRCULAR` - Circularly add the new data (Like an ECG diagram).
The update mode can be changed with `lv_chart_set_update_mode(chart, LV_CHART_UPDATE_MODE_...)`. The update mode can be changed with `lv_chart_set_update_mode(chart, LV_CHART_UPDATE_MODE_...)`.

4
src/extra/widgets/chart/lv_chart.h
View File

@@ -114,7 +114,7 @@ extern const lv_obj_class_t lv_chart_class;
/** /**
* Create a chart objects * Create a chart objects
* @param parent pointer to an object, it will be the parent of the new button * @param parent pointer to an object, it will be the parent of the new chart
* @return pointer to the created chart * @return pointer to the created chart
*/ */
lv_obj_t * lv_chart_create(lv_obj_t * parent); lv_obj_t * lv_chart_create(lv_obj_t * parent);
@@ -127,7 +127,7 @@ lv_obj_t * lv_chart_create(lv_obj_t * parent);
void lv_chart_set_type(lv_obj_t * obj, lv_chart_type_t type); void lv_chart_set_type(lv_obj_t * obj, lv_chart_type_t type);
/** /**
* Set the number of points on a data line on a chart * Set the number of points on a data line on a chart
* @param obj pointer r to chart object * @param obj pointer to a chart object
* @param cnt new number of points on the data lines * @param cnt new number of points on the data lines
*/ */
void lv_chart_set_point_count(lv_obj_t * obj, uint16_t cnt); void lv_chart_set_point_count(lv_obj_t * obj, uint16_t cnt);