libaria_widget_bar

Microchip Technology Inc.

File Name

libaria_widget_bar_graph.h

Description

Module for Microchip Graphics Library - Aria User Interface Library

This module implements bar graph drawing widget functions.

Enumerations

	Name	Description
	laBarGraphTickPosition_t	The tick position relative to axis
	laBarGraphValueAxis_t	The value axis index value
	laBarGraphTickPosition	The tick position relative to axis
	laBarGraphValueAxis	The value axis index value

Functions

	Name	Description
	laBarGraphWidget_AddCategory	Adds a category to the graph
	laBarGraphWidget_AddDataToSeries	Adds a data (value) to the specified series at categoryID index
	laBarGraphWidget_AddSeries	Adds a series to the graph
	laBarGraphWidget_DestroyAll	Destroys data, series and categories and frees the memory allocated
	laBarGraphWidget_GetCategoryAxisLabelsVisible	Returns GFX_TRUE if the category axis labels are visible
	laBarGraphWidget_GetCategoryAxisTicksPosition	Returns the position of the ticks in the category axis
	laBarGraphWidget_GetCategoryAxisTicksVisible	Returns GFX_TRUE if the category axis ticks are visible
	laBarGraphWidget_GetCategoryText	Gets a copy of the string used to label the category
	laBarGraphWidget_GetFillGraphArea	Returns GFX_TRUE if the category axis labels are visible
	laBarGraphWidget_GetGridlinesVisible	Returns GFX_TRUE if the axis gridlines are visible
	laBarGraphWidget_GetMaxValue	Returns the max value of the axis
	laBarGraphWidget_GetMinValue	Returns the min value of the axis
	laBarGraphWidget_GetSeriesScheme	Returns scheme of the specified series
	laBarGraphWidget_GetStacked	Returns GFX_TRUE if the bars are stacked
	laBarGraphWidget_GetTickLength	Returns the length of the ticks
	laBarGraphWidget_GetValueAxisLabelsVisible	Returns GFX_TRUE if the value axis labels are visible
	laBarGraphWidget_GetValueAxisSubtickInterval	Returns the interval between minor ticks in the value axis
	laBarGraphWidget_GetValueAxisSubticksPosition	Returns the position of the subticks in the axis
	laBarGraphWidget_GetValueAxisSubticksVisible	Returns GFX_TRUE if the value axis subticks are visible
	laBarGraphWidget_GetValueAxisTickInterval	Returns the interval between major ticks in the value axis
	laBarGraphWidget_GetValueAxisTicksPosition	Returns the position of the ticks in the axis
	laBarGraphWidget_GetValueAxisTicksVisible	Returns GFX_TRUE if the value axis ticks are visible
	laBarGraphWidget_New	Allocates memory for and initializes a new widget of this type. The application is responsible for the management of this memory until the widget is added to a widget tree.
	laBarGraphWidget_SetCategoryAxisLabelsVisible	Shows/Hides the category axis labels
	laBarGraphWidget_SetCategoryAxisTicksPosition	Sets the position of the ticks in the category axis
	laBarGraphWidget_SetCategoryAxisTicksVisible	Shows/Hides the category axis ticks
	laBarGraphWidget_SetCategoryText	Sets the string used to label the category
	laBarGraphWidget_SetDataInSeries	Sets the value of the entry in the series index. The entry should have been previously
	laBarGraphWidget_SetFillGraphArea	Sets the graph area filled or not
	laBarGraphWidget_SetGridlinesVisible	Shows/Hides the gridlines
	laBarGraphWidget_SetMaxValue	Sets the max value of the axis
	laBarGraphWidget_SetMinValue	Sets the min value of the axis
	laBarGraphWidget_SetSeriesScheme	Sets the color scheme of the series
	laBarGraphWidget_SetStacked	Stacks the bar graph
	laBarGraphWidget_SetStringTable	Sets the string table used for the generated axis labels
	laBarGraphWidget_SetTickLength	Sets the length of the ticks
	laBarGraphWidget_SetTicksLabelsStringID	Sets the ID of the superset string used for the value axis tick labels
	laBarGraphWidget_SetValueAxisLabelsVisible	Shows/Hides the labels in the value axis
	laBarGraphWidget_SetValueAxisSubtickInterval	Sets the minor tick interval in the value axis
	laBarGraphWidget_SetValueAxisSubticksPosition	Sets the position of the subticks in the value axis
	laBarGraphWidget_SetValueAxisSubticksVisible	Shows/Hides the subticks in the value axis
	laBarGraphWidget_SetValueAxisTickInterval	Sets the tick interval in the value axis
	laBarGraphWidget_SetValueAxisTicksPosition	Sets the position of the ticks in the value axis
	laBarGraphWidget_SetValueAxisTicksVisible	Shows/Hides the ticks in the value axis

Macros

	Name	Description
	LABEL_OFFSET_MIN_PIX	This is macro LABEL_OFFSET_MIN_PIX.
	LIBARIA_WIDGET_BAR_GRAPH_H	This is macro LIBARIA_WIDGET_BAR_GRAPH_H.
	MAX_TICK_LABEL_DIGITS
	MAX_TICK_LABEL_VALUE	This is macro MAX_TICK_LABEL_VALUE.

Structures

	Name	Description
	laBarGraphCategory_t	Contains the Category properties
	laBarGraphDataSeries_t	The data series object that contains the series properties and data
	laBarGraphWidget_t	Implementation of a bar graph widget.
	laBarGraphCategory	Contains the Category properties
	laBarGraphDataSeries	The data series object that contains the series properties and data
	laBarGraphWidget	Implementation of a bar graph widget.

MPLAB® Harmony Graphics Suite > Graphics Library > Aria Graphics Library > Files > libaria_widget_bar_graph.h

MPLAB® Harmony Graphics Suite

Contents | Home

Previous | Up | Next

Documentation Feedback
Microchip Support