メイン・コンテンツまでスキップ

AbstractDataGraph

touchgfx/widgets/graph/AbstractDataGraph.hpp

An abstract data graph. This class is the base for other graphs. For specific graphs, please refer to those implementation, e.g. GraphScroll, GraphWrapAndClear, GraphWrapAndOverwrite and StaticGraph.

Inherits from: Container, Drawable

Inherited by: DynamicDataGraph, StaticDataGraph

Public Classes

classGraphClickEvent
An object of this type is passed with each callback that is sent when the graph is clicked.
classGraphDragEvent
An object of this type is passed with each callback that is sent when the graph is dragged.

Public Functions

AbstractDataGraph(int16_t capacity)
Initializes a new instance of the AbstractDataGraph class.
voidaddBottomElement(AbstractGraphDecoration & d)
Adds an element to be shown in the area below the graph.
voidaddGraphElement(AbstractGraphElement & d)
Adds a graph element which will display the graph.
voidaddLeftElement(AbstractGraphDecoration & d)
Adds an element to be shown in the area to the left of the graph.
voidaddRightElement(AbstractGraphDecoration & d)
Adds an element to be shown in the area to the right of the graph.
voidaddTopElement(AbstractGraphDecoration & d)
Adds an element to be shown in the area above the graph.
virtual voidclear()
Clears the graph to its blank/initial state.
FORCE_INLINE_FUNCTION intfloat2scaledX(float f) const
Same as float2scaled(float, int) using the graph's x scale.
FORCE_INLINE_FUNCTION intfloat2scaledY(float f) const
Same as float2scaled(float, int) using the graph's y scale.
FORCE_INLINE_FUNCTION uint8_tgetAlpha() const
Gets the current alpha value of the widget.
FORCE_INLINE_FUNCTION int16_tgetGapBeforeIndex() const
Gets gap before index as set using setGapBeforeIndex().
FORCE_INLINE_FUNCTION int16_tgetGraphAreaHeight() const
Gets graph area height.
FORCE_INLINE_FUNCTION int16_tgetGraphAreaHeightIncludingPadding() const
Gets graph area height including padding (but not margin).
FORCE_INLINE_FUNCTION int16_tgetGraphAreaMarginBottom() const
Gets graph margin bottom.
FORCE_INLINE_FUNCTION int16_tgetGraphAreaMarginLeft() const
Gets graph margin left.
FORCE_INLINE_FUNCTION int16_tgetGraphAreaMarginRight() const
Gets graph margin right.
FORCE_INLINE_FUNCTION int16_tgetGraphAreaMarginTop() const
Gets graph margin top.
FORCE_INLINE_FUNCTION int16_tgetGraphAreaPaddingBottom() const
Gets graph area padding bottom.
FORCE_INLINE_FUNCTION int16_tgetGraphAreaPaddingLeft() const
Gets graph area padding left.
FORCE_INLINE_FUNCTION int16_tgetGraphAreaPaddingRight() const
Gets graph area padding right.
FORCE_INLINE_FUNCTION int16_tgetGraphAreaPaddingTop() const
Gets graph area padding top.
FORCE_INLINE_FUNCTION int16_tgetGraphAreaWidth() const
Gets graph area width.
FORCE_INLINE_FUNCTION int16_tgetGraphAreaWidthIncludingPadding() const
Gets graph area width including padding (but not margin).
virtual floatgetGraphRangeXMaxAsFloat() const
Gets maximum x value for the graph.
virtual intgetGraphRangeXMaxAsInt() const
Gets maximum x value for the graph.
virtual intgetGraphRangeXMaxScaled() const
Gets maximum x value for the graph.
virtual floatgetGraphRangeXMinAsFloat() const
Gets minimum x value for the graph.
virtual intgetGraphRangeXMinAsInt() const
Gets minimum x value for the graph.
virtual intgetGraphRangeXMinScaled() const
Gets minimum x value for the graph.
virtual floatgetGraphRangeYMaxAsFloat() const
Gets maximum y value for the graph.
virtual intgetGraphRangeYMaxAsInt() const
Gets maximum y value for the graph.
virtual intgetGraphRangeYMaxScaled() const
Gets maximum y value for the graph.
virtual floatgetGraphRangeYMinAsFloat() const
Gets minimum y value for the graph.
virtual intgetGraphRangeYMinAsInt() const
Gets minimum y value for the graph.
virtual intgetGraphRangeYMinScaled() const
Gets minimum y value for the graph.
FORCE_INLINE_FUNCTION int16_tgetMaxCapacity() const
Gets the capacity (max number of points) of the graph.
virtual boolgetNearestIndexForScreenX(int16_t x, int16_t & index) const
Gets graph index nearest to the given screen x value.
virtual boolgetNearestIndexForScreenXY(int16_t x, int16_t y, int16_t & index)
Gets graph index nearest to the given screen position.
virtual intgetScaleX() const
Gets the scaling factor previously set using setScaleX().
virtual intgetScaleY() const
Gets the scaling factor previously set using setScaleY().
FORCE_INLINE_FUNCTION int16_tgetUsedCapacity() const
Gets the number of point used by the graph.
virtual voidhandleClickEvent(const ClickEvent & event)
Defines the event handler interface for ClickEvents.
virtual voidhandleDragEvent(const DragEvent & event)
Defines the event handler interface for DragEvents.
FORCE_INLINE_FUNCTION voidindexToDataPoint(int16_t index, float & xvalue, float & yvalue) const
Gets data point as floating point values.
FORCE_INLINE_FUNCTION voidindexToDataPoint(int16_t index, int & xvalue, int & yvalue) const
Gets data point as integer values.
FORCE_INLINE_FUNCTION voidindexToDataPointScaled(int16_t index, int & xvalue, int & yvalue) const
Gets data point as raw (scaled) values.
FORCE_INLINE_FUNCTION floatindexToDataPointXAsFloat(int16_t index) const
Gets data point x coordinate as float.
FORCE_INLINE_FUNCTION intindexToDataPointXAsInt(int16_t index) const
Gets data point x coordinate as int.
virtual intindexToDataPointXScaled(int16_t index) const =0
Gets data point x coordinate scaled.
FORCE_INLINE_FUNCTION floatindexToDataPointYAsFloat(int16_t index) const
Gets data point y coordinate as float.
FORCE_INLINE_FUNCTION intindexToDataPointYAsInt(int16_t index) const
Gets data point y coordinate as int.
virtual intindexToDataPointYScaled(int16_t index) const =0
Gets data point y coordinate scaled.
FORCE_INLINE_FUNCTION int16_tindexToScreenX(int16_t index) const
Get the screen x coordinate for the given graph point index.
FORCE_INLINE_FUNCTION int16_tindexToScreenY(int16_t index) const
Get the screen y coordinate for the given graph point index.
FORCE_INLINE_FUNCTION intint2scaledX(int i) const
Same as int2scaled(int, int) using the graph's x scale.
FORCE_INLINE_FUNCTION intint2scaledY(int i) const
Same as int2scaled(int, int) using the graph's y scale.
virtual voidinvalidateContent() const
Invalidate content.
FORCE_INLINE_FUNCTION floatscaled2floatX(int i) const
Same as scaled2float(int, int) using the graph's x scale.
FORCE_INLINE_FUNCTION floatscaled2floatY(int i) const
Same as scaled2float(int, int) using the graph's y scale.
FORCE_INLINE_FUNCTION intscaled2intX(int i) const
Same as scaled2int(int, int) using the graph's x scale.
FORCE_INLINE_FUNCTION intscaled2intY(int i) const
Same as scaled2int(int, int) using the graph's y scale.
virtual voidsetAlpha(uint8_t newAlpha)
Sets the opacity (alpha value).
FORCE_INLINE_FUNCTION voidsetClickAction(GenericCallback< const AbstractDataGraph &, const GraphClickEvent & > & callback)
Sets an action to be executed when the graph is clicked.
FORCE_INLINE_FUNCTION voidsetDragAction(GenericCallback< const AbstractDataGraph &, const GraphDragEvent & > & callback)
Sets an action to be executed when the graph is dragged.
FORCE_INLINE_FUNCTION voidsetGapBeforeIndex(int16_t index)
Makes gap before the specified index.
voidsetGraphAreaMargin(int16_t top, int16_t left, int16_t right, int16_t bottom)
Sets graph position inside the widget by reserving a margin around the graph.
voidsetGraphAreaPadding(int16_t top, int16_t left, int16_t right, int16_t bottom)
Adds padding around the graph that will not be drawn in (apart from dots, boxes, lines etc.
FORCE_INLINE_FUNCTION voidsetGraphRange(float xMin, float xMax, float yMin, float yMax)
Sets minimum and maximum x and y coordinate ranges for the graph.
FORCE_INLINE_FUNCTION voidsetGraphRange(float xMin, float xMax, int yMin, int yMax)
Sets minimum and maximum x and y coordinate ranges for the graph.
FORCE_INLINE_FUNCTION voidsetGraphRange(int xMin, int xMax, float yMin, float yMax)
Sets minimum and maximum x and y coordinate ranges for the graph.
FORCE_INLINE_FUNCTION voidsetGraphRange(int xMin, int xMax, int yMin, int yMax)
Sets minimum and maximum x and y coordinate ranges for the graph.
FORCE_INLINE_FUNCTION voidsetGraphRangeScaled(int xMin, int xMax, int yMin, int yMax)
Same as setGraphRange(int, int, int, int) except the passed arguments are assumed scaled.
virtual voidsetGraphRangeX(float min, float max)
Sets minimum and maximum x coordinates for the graph.
virtual voidsetGraphRangeX(int min, int max)
Sets minimum and maximum x coordinates for the graph.
virtual voidsetGraphRangeXAuto(bool showYaxis, float margin)
Automatically adjust min and max x coordinate to show entire graph.
virtual voidsetGraphRangeXAuto(bool showYaxis =true, int margin =0)
Automatically adjust min and max x coordinate to show entire graph.
virtual voidsetGraphRangeXAutoScaled(bool showYaxis, int margin) =0
Automatically adjust min and max x coordinate to show entire graph.
virtual voidsetGraphRangeXScaled(int min, int max)
Sets minimum and maximum x coordinates for the graph.
virtual voidsetGraphRangeY(float min, float max)
Sets minimum and maximum y coordinates for the graph.
virtual voidsetGraphRangeY(int min, int max)
Sets minimum and maximum y coordinates for the graph.
virtual voidsetGraphRangeYAuto(bool showXaxis, float margin)
Automatic adjust min and max y coordinate to show entire graph.
virtual voidsetGraphRangeYAuto(bool showXaxis =true, int margin =0)
Automatic adjust min and max y coordinate to show entire graph.
virtual voidsetGraphRangeYAutoScaled(bool showXaxis, int margin) =0
Automatic adjust min and max y coordinate to show entire graph.
virtual voidsetGraphRangeYScaled(int min, int max)
Same as setGraphRangeY(int, int) except the passed arguments are assumed scaled.
virtual voidsetHeight(int16_t height)
Sets the height of this drawable.
virtual voidsetScaleX(int scale, bool updateData =false)
Sets a scaling factor to be multiplied on each X value added.
virtual voidsetScaleY(int scale, bool updateData =false)
Sets a scaling factor to be multiplied on each Y value added.
virtual voidsetWidth(int16_t width)
Sets the width of this drawable.
intconvertToNewScale(int value, int oldScale, int newScale)
Converts a value from one scale to another scale.
FORCE_INLINE_FUNCTION intfloat2scaled(float f, int scale)
Multiply a floating point value with a constant and round the result.
FORCE_INLINE_FUNCTION intint2scaled(int i, int scale)
Multiply an integer value with a constant.
FORCE_INLINE_FUNCTION floatscaled2float(int i, int scale)
Divide a floating point number with a constant.
FORCE_INLINE_FUNCTION intscaled2int(int i, int scale)
Divide an integer with a constant and round the result.

Protected Functions

virtual CWRUtil::Q5indexToScreenXQ5(int16_t index) const =0
Gets screen x coordinate for a specific data point added to the graph.
virtual CWRUtil::Q5indexToScreenYQ5(int16_t index) const =0
Gets screen y coordinate for a specific data point added to the graph.
virtual intindexToXAxis(const int valueScaled, const int labelScaled) const =0
Convert the given valueScaled (index) to x axis value.
voidinvalidateAllXAxisPoints()
Invalidate all x axis points.
FORCE_INLINE_FUNCTION voidinvalidateGraphArea() const
Invalidate entire graph area (the center of the graph).
voidinvalidateGraphPointAt(int16_t index)
Invalidate point at a given index.
voidinvalidateXAxisPointAt(int16_t index)
Invalidate x axis point at the given index.
voidupdateAreasPosition()
Updates the position of all elements in all area after a change in size of the graph area and/or label padding.
virtual CWRUtil::Q5valueToScreenXQ5(int x) const
Gets screen x coordinate for an absolute value.
virtual CWRUtil::Q5valueToScreenYQ5(int y) const
Gets screen y coordinate for an absolute value.
virtual boolxScreenRangeToIndexRange(int16_t xMin, int16_t xMax, int16_t & indexMin, int16_t & indexMax) const =0
Gets index range for screen x coordinate range taking the current graph range into account.

Protected Attributes

uint8_talpha
The alpha of the entire graph.
ContainerbottomArea
The area below the graph.
int16_tbottomPadding
The graph area bottom padding.
GenericCallback< const AbstractDataGraph &, const GraphClickEvent & > *clickAction
The callback to be executed when this Graph is clicked.
GenericCallback< const AbstractDataGraph &, const GraphDragEvent & > *dragAction
The callback to be executed when this Graph is dragged.
int16_tgapBeforeIndex
The graph is disconnected (there is a gap) before this element index.
ContainergraphArea
The graph area (the center area)
intgraphRangeMaxX
The graph range maximum x coordinate.
intgraphRangeMaxY
The graph range maximum y coordinate.
intgraphRangeMinX
The graph range minimum x coordinate.
intgraphRangeMinY
The graph range minimum y coordinate.
ContainerleftArea
The area to the left of the graph.
int16_tleftPadding
The graph area left padding.
int16_tmaxCapacity
Maximum number of points in the graph.
ContainerrightArea
The area to the right of the graph.
int16_trightPadding
The graph area right padding.
ContainertopArea
The area above the graph.
int16_ttopPadding
The graph area top padding.
int16_tusedCapacity
The number of used points in the graph.
intxScale
The data scale for the x values.
intyScale
The data scale for the y values.

Additional inherited members

Public Functions inherited from Container

virtual voidadd(Drawable & d)
Adds a Drawable instance as child to this Container.
Container()
virtual boolcontains(const Drawable & d)
Query if a given Drawable has been added directly to this Container.
virtual voiddraw(const Rect & invalidatedArea) const
Draw this drawable.
virtual voidforEachChild(GenericCallback< Drawable & > * function)
Executes the specified callback function for each child in the Container.
virtual Drawable *getFirstChild()
Obtain a pointer to the first child of this container.
virtual voidgetLastChild(int16_t x, int16_t y, Drawable ** last)
Gets the last child in the list of children in this Container.
virtual voidgetLastChildNear(int16_t x, int16_t y, Drawable * last, int16_t fingerAdjustmentX, int16_t * fingerAdjustmentY)
Works similar to getLastChild() but also considers the current set finger size in HAL.
virtual RectgetSolidRect() const
Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual voidinsert(Drawable * previous, Drawable & d)
Inserts a Drawable after a specific child node.
virtual voidremove(Drawable & d)
Removes a Drawable from the container by removing it from the linked list of children.
virtual voidremoveAll()
Removes all children in the Container by resetting their parent and sibling pointers.
virtual voidunlink()
Removes all children by unlinking the first child.

Protected Functions inherited from Container

virtual RectgetContainedArea() const
Gets a rectangle describing the total area covered by the children of this container.
virtual voidmoveChildrenRelative(int16_t deltaX, int16_t deltaY)
Calls moveRelative on all children.

Protected Attributes inherited from Container

Drawable *firstChild
Pointer to the first child of this container. Subsequent children can be found through firstChild's nextSibling.

Public Functions inherited from Drawable

voidcenter()
Centers the Drawable inside its parent.
voidcenterX()
Center the Drawable horizontally inside its parent.
voidcenterY()
Center the Drawable vertically inside its parent.
virtual voidchildGeometryChanged()
This function can be called on parent nodes to signal that the size or position of one or more of its children has changed.
virtual voiddraw(const Rect & invalidatedArea) const =0
Draw this drawable.
Drawable()
Initializes a new instance of the Drawable class.
voiddrawToDynamicBitmap(BitmapId id)
Render the Drawable object into a dynamic bitmap.
voidexpand(int margin =0)
Expands the Drawable to have the same size as its parent with a given margin around the edge.
RectgetAbsoluteRect() const
Helper function for obtaining the rectangle this Drawable covers, expressed in absolute coordinates.
virtual Drawable *getFirstChild()
Function for obtaining the first child of this drawable if any.
int16_tgetHeight() const
Gets the height of this Drawable.
virtual voidgetLastChild(int16_t x, int16_t y, Drawable ** last) =0
Function for obtaining the the last child of this drawable that intersects with the specified point.
Drawable *getNextSibling()
Gets the next sibling node.
Drawable *getParent() const
Returns the parent node.
const Rect &getRect() const
Gets the rectangle this Drawable covers, in coordinates relative to its parent.
virtual RectgetSolidRect() const =0
Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual RectgetSolidRectAbsolute()
Helper function for obtaining the largest solid rect (as implemented by getSolidRect()) expressed in absolute coordinates.
virtual voidgetVisibleRect(Rect & rect) const
Function for finding the visible part of this drawable.
int16_tgetWidth() const
Gets the width of this Drawable.
int16_tgetX() const
Gets the x coordinate of this Drawable, relative to its parent.
int16_tgetY() const
Gets the y coordinate of this Drawable, relative to its parent.
virtual voidhandleGestureEvent(const GestureEvent & event)
Defines the event handler interface for GestureEvents.
virtual voidhandleTickEvent()
Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
virtual voidinvalidate() const
Tell the framework that this entire Drawable needs to be redrawn.
virtual voidinvalidateRect(Rect & invalidatedArea) const
Request that a region of this drawable is redrawn.
boolisTouchable() const
Gets whether this Drawable receives touch events or not.
boolisVisible() const
Gets whether this Drawable is visible.
virtual voidmoveRelative(int16_t x, int16_t y)
Moves the drawable.
virtual voidmoveTo(int16_t x, int16_t y)
Moves the drawable.
voidsetPosition(const Drawable & drawable)
Sets the position of the Drawable to the same as the given Drawable.
voidsetPosition(int16_t x, int16_t y, int16_t width, int16_t height)
Sets the size and position of this Drawable, relative to its parent.
voidsetTouchable(bool touch)
Controls whether this Drawable receives touch events or not.
voidsetVisible(bool vis)
Controls whether this Drawable should be visible.
voidsetWidthHeight(const Bitmap & bitmap)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(const Drawable & drawable)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(const Rect & other)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(int16_t width, int16_t height)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
virtual voidsetX(int16_t x)
Sets the x coordinate of this Drawable, relative to its parent.
voidsetXY(const Drawable & drawable)
Sets the x and y coordinates of this Drawable.
voidsetXY(int16_t x, int16_t y)
Sets the x and y coordinates of this Drawable, relative to its parent.
virtual voidsetY(int16_t y)
Sets the y coordinate of this Drawable, relative to its parent.
virtual voidtranslateRectToAbsolute(Rect & r) const
Helper function for converting a region of this Drawable to absolute coordinates.
virtual ~Drawable()
Finalizes an instance of the Drawable class.

Protected Attributes inherited from Drawable

Drawable *nextSibling
Pointer to the next Drawable.
Drawable *parent
Pointer to this drawable's parent.
Rectrect
The coordinates of this Drawable, relative to its parent.
booltouchable
True if this drawable should receive touch events.
boolvisible
True if this drawable should be drawn.

Public Functions Documentation

AbstractDataGraph

AbstractDataGraph(int16_tcapacity)

Initializes a new instance of the AbstractDataGraph class.

Parameters:
capacityThe capacity, i.e. the number of points in the graph.

addBottomElement

Adds an element to be shown in the area below the graph.

Labels and titles can be added here.

Parameters:
See also:

addGraphElement

Adds a graph element which will display the graph.

Several graph elements can be added. Examples of graph elements are lines, dots, histograms as well as horizontal and vertical grid lines.

Parameters:
See also:

addLeftElement

Adds an element to be shown in the area to the left of the graph.

Labels and titles can be added here.

Parameters:
See also:

addRightElement

Adds an element to be shown in the area to the right of the graph.

Labels and titles can be added here.

Parameters:
See also:

addTopElement

Adds an element to be shown in the area above the graph.

Labels and titles can be added here.

Parameters:
See also:

clear

virtual void clear()

Clears the graph to its blank/initial state.

The graph is invalidated so that the empty graph will be drawn after a call to clear.

Reimplemented by: touchgfx::GraphScrollData::clear, touchgfx::GraphWrapAndClearData::clear, touchgfx::GraphWrapAndOverwriteData::clear

float2scaledX

FORCE_INLINE_FUNCTION int float2scaledX(floatf)

Same as float2scaled(float, int) using the graph's x scale.

Parameters:
fThe floating point value to scale.
Returns:

The scaled value.

Note

For internal use.

float2scaledY

FORCE_INLINE_FUNCTION int float2scaledY(floatf)

Same as float2scaled(float, int) using the graph's y scale.

Parameters:
fThe floating point value to scale.
Returns:

The scaled value.

Note

For internal use.

getAlpha

FORCE_INLINE_FUNCTION uint8_t getAlpha()const

Gets the current alpha value of the widget.

The alpha value is in range 255 (solid) to 0 (invisible).

Returns:

The current alpha value.

See also:

getGapBeforeIndex

FORCE_INLINE_FUNCTION int16_t getGapBeforeIndex()const

Gets gap before index as set using setGapBeforeIndex().

Returns:

The gap before index.

See also:

getGraphAreaHeight

FORCE_INLINE_FUNCTION int16_t getGraphAreaHeight()const

Gets graph area height.

This is the height of the actual graph area and is the same as the height of the graph widget minus margin and padding.

Returns:

The graph area height.

See also:

getGraphAreaHeightIncludingPadding

FORCE_INLINE_FUNCTION int16_t getGraphAreaHeightIncludingPadding()const

Gets graph area height including padding (but not margin).

This is the height of the actual graph area and is the same as the height of the graph widget minus margin.

Returns:

The graph area height including graph padding.

See also:

getGraphAreaMarginBottom

FORCE_INLINE_FUNCTION int16_t getGraphAreaMarginBottom()const

Gets graph margin bottom.

Returns:

The graph margin bottom.

See also:

getGraphAreaMarginLeft

FORCE_INLINE_FUNCTION int16_t getGraphAreaMarginLeft()const

Gets graph margin left.

Returns:

The graph margin left.

See also:

getGraphAreaMarginRight

FORCE_INLINE_FUNCTION int16_t getGraphAreaMarginRight()const

Gets graph margin right.

Returns:

The graph margin right.

See also:

getGraphAreaMarginTop

FORCE_INLINE_FUNCTION int16_t getGraphAreaMarginTop()const

Gets graph margin top.

Returns:

The graph margin top.

See also:

getGraphAreaPaddingBottom

FORCE_INLINE_FUNCTION int16_t getGraphAreaPaddingBottom()const

Gets graph area padding bottom.

Returns:

The graph area padding bottom.

See also:

getGraphAreaPaddingLeft

FORCE_INLINE_FUNCTION int16_t getGraphAreaPaddingLeft()const

Gets graph area padding left.

Returns:

The graph area padding left.

See also:

getGraphAreaPaddingRight

FORCE_INLINE_FUNCTION int16_t getGraphAreaPaddingRight()const

Gets graph area padding right.

Returns:

The graph area padding right.

See also:

getGraphAreaPaddingTop

FORCE_INLINE_FUNCTION int16_t getGraphAreaPaddingTop()const

Gets graph area padding top.

Returns:

The graph area padding top.

See also:

getGraphAreaWidth

FORCE_INLINE_FUNCTION int16_t getGraphAreaWidth()const

Gets graph area width.

This is the width of the actual graph area and is the same as the width of the graph widget minus margin and padding.

Returns:

The graph area width.

See also:

getGraphAreaWidthIncludingPadding

FORCE_INLINE_FUNCTION int16_t getGraphAreaWidthIncludingPadding()const

Gets graph area width including padding (but not margin).

This is the width of the actual graph area and is the same as the width of the graph widget minus margin.

Returns:

The graph width including graph padding.

See also:

getGraphRangeXMaxAsFloat

virtual float getGraphRangeXMaxAsFloat()const

Gets maximum x value for the graph.

Returns:

The maximum x value.

getGraphRangeXMaxAsInt

virtual int getGraphRangeXMaxAsInt()const

Gets maximum x value for the graph.

Returns:

The maximum x value.

getGraphRangeXMaxScaled

virtual int getGraphRangeXMaxScaled()const

Gets maximum x value for the graph.

Returns:

The maximum x value. The graph range x coordinate maximum scaled.

Note

The returned value is left scaled.

See also:

getGraphRangeXMinAsFloat

virtual float getGraphRangeXMinAsFloat()const

Gets minimum x value for the graph.

Returns:

The minimum x value.

getGraphRangeXMinAsInt

virtual int getGraphRangeXMinAsInt()const

Gets minimum x value for the graph.

Returns:

The minimum x value.

getGraphRangeXMinScaled

virtual int getGraphRangeXMinScaled()const

Gets minimum x value for the graph.

Returns:

The minimum x value. The graph range x coordinate minimum scaled.

Note

The returned value is left scaled.

See also:

getGraphRangeYMaxAsFloat

virtual float getGraphRangeYMaxAsFloat()const

Gets maximum y value for the graph.

Returns:

The maximum y value.

getGraphRangeYMaxAsInt

virtual int getGraphRangeYMaxAsInt()const

Gets maximum y value for the graph.

Returns:

The maximum y value.

getGraphRangeYMaxScaled

virtual int getGraphRangeYMaxScaled()const

Gets maximum y value for the graph.

Returns:

The maximum y value.

Note

The returned value is left scaled.

See also:

getGraphRangeYMinAsFloat

virtual float getGraphRangeYMinAsFloat()const

Gets minimum y value for the graph.

Returns:

The minimum y value.

getGraphRangeYMinAsInt

virtual int getGraphRangeYMinAsInt()const

Gets minimum y value for the graph.

Returns:

The minimum y value.

getGraphRangeYMinScaled

virtual int getGraphRangeYMinScaled()const

Gets minimum y value for the graph.

Returns:

The minimum y value.

Note

The returned value is left scaled.

See also:

getMaxCapacity

FORCE_INLINE_FUNCTION int16_t getMaxCapacity()const

Gets the capacity (max number of points) of the graph.

Returns:

The capacity.

getNearestIndexForScreenX

virtual bool getNearestIndexForScreenX(int16_tx ,const
int16_t &indexconst
)const

Gets graph index nearest to the given screen x value.

The index of the graph point closest to the given x coordinate is handed back.

Parameters:
xThe x value.
indexZero-based index of the.
Returns:

True if it succeeds, false if it fails.

See also:

getNearestIndexForScreenXY

virtual bool getNearestIndexForScreenXY(int16_tx ,
int16_ty ,
int16_t &index
)

Gets graph index nearest to the given screen position.

The distance to each point on the graph is measured and the index of the point closest to the given position handed back.

Parameters:
xThe x value.
yThe y value.
indexZero-based index of the point closest to the given position.
Returns:

True if it succeeds, false if it fails.

See also:

getScaleX

virtual int getScaleX()const

Gets the scaling factor previously set using setScaleX().

Returns:

The scaling factor.

See also:

Reimplemented by: touchgfx::DynamicDataGraph::getScaleX

getScaleY

virtual int getScaleY()const

Gets the scaling factor previously set using setScaleY().

Returns:

The scaling factor.

See also:

Reimplemented by: touchgfx::DynamicDataGraph::getScaleY

getUsedCapacity

FORCE_INLINE_FUNCTION int16_t getUsedCapacity()const

Gets the number of point used by the graph.

Returns:

The number of point used by the graph.

handleClickEvent

virtual void handleClickEvent(const ClickEvent &event)

Defines the event handler interface for ClickEvents.

The default implementation ignores the event. The event is only received if the Drawable is touchable and visible.

Parameters:
eventThe ClickEvent received from the HAL.

Reimplements: touchgfx::Drawable::handleClickEvent

handleDragEvent

virtual void handleDragEvent(const DragEvent &event)

Defines the event handler interface for DragEvents.

The default implementation ignores the event. The event is only received if the drawable is touchable and visible.

Parameters:
eventThe DragEvent received from the HAL.

Reimplements: touchgfx::Drawable::handleDragEvent

indexToDataPoint

FORCE_INLINE_FUNCTION void indexToDataPoint(int16_tindex ,const
float &xvalue ,const
float &yvalueconst
)const

Gets data point as floating point values.

Parameters:
indexZero-based index of the values to fetch.
xvalueThe x value.
yvalueThe y value.
See also:

indexToDataPoint

FORCE_INLINE_FUNCTION void indexToDataPoint(int16_tindex ,const
int &xvalue ,const
int &yvalueconst
)const

Gets data point as integer values.

Parameters:
indexZero-based index of the values to fetch.
xvalueThe x value.
yvalueThe y value.
See also:

indexToDataPointScaled

FORCE_INLINE_FUNCTION void indexToDataPointScaled(int16_tindex ,const
int &xvalue ,const
int &yvalueconst
)const

Gets data point as raw (scaled) values.

Parameters:
indexZero-based index of the values to fetch.
xvalueThe x value.
yvalueThe y value.

indexToDataPointXAsFloat

FORCE_INLINE_FUNCTION float indexToDataPointXAsFloat(int16_tindex)

Gets data point x coordinate as float.

Parameters:
indexZero-based index of the value to fetch.
Returns:

The data point x coordinate as float.

See also:

indexToDataPointXAsInt

FORCE_INLINE_FUNCTION int indexToDataPointXAsInt(int16_tindex)

Gets data point x coordinate as int.

Parameters:
indexZero-based index of the value to fetch.
Returns:

The data point x coordinate as int.

See also:

indexToDataPointXScaled

virtual int indexToDataPointXScaled(int16_tindex)

Gets data point x coordinate scaled.

Parameters:
indexZero-based index of the value to fetch.
Returns:

The data point x coordinate scaled.

See also:

Reimplemented by: touchgfx::DynamicDataGraph::indexToDataPointXScaled, touchgfx::StaticDataGraph::indexToDataPointXScaled

indexToDataPointYAsFloat

FORCE_INLINE_FUNCTION float indexToDataPointYAsFloat(int16_tindex)

Gets data point y coordinate as float.

Parameters:
indexZero-based index of the value to fetch.
Returns:

The data point y coordinate as float.

See also:

indexToDataPointYAsInt

FORCE_INLINE_FUNCTION int indexToDataPointYAsInt(int16_tindex)

Gets data point y coordinate as int.

Parameters:
indexZero-based index of the value to fetch.
Returns:

The data point y coordinate as int.

See also:

indexToDataPointYScaled

virtual int indexToDataPointYScaled(int16_tindex)

Gets data point y coordinate scaled.

Parameters:
indexZero-based index of the value to fetch.
Returns:

The data point y coordinate scaled.

See also:

Reimplemented by: touchgfx::DynamicDataGraph::indexToDataPointYScaled, touchgfx::StaticDataGraph::indexToDataPointYScaled

indexToScreenX

FORCE_INLINE_FUNCTION int16_t indexToScreenX(int16_tindex)

Get the screen x coordinate for the given graph point index.

Parameters:
indexZero-based index of the point.
Returns:

The screen x value.

indexToScreenY

FORCE_INLINE_FUNCTION int16_t indexToScreenY(int16_tindex)

Get the screen y coordinate for the given graph point index.

Parameters:
indexZero-based index of the point.
Returns:

The screen x value.

int2scaledX

FORCE_INLINE_FUNCTION int int2scaledX(inti)

Same as int2scaled(int, int) using the graph's x scale.

Parameters:
iThe integer value to scale.
Returns:

The scaled integer.

Note

For internal use.

int2scaledY

FORCE_INLINE_FUNCTION int int2scaledY(inti)

Same as int2scaled(int, int) using the graph's y scale.

Parameters:
iThe integer value to scale.
Returns:

The scaled integer.

Note

For internal use.

invalidateContent

virtual void invalidateContent()const

Invalidate content.

Reimplements: touchgfx::Drawable::invalidateContent

scaled2floatX

FORCE_INLINE_FUNCTION float scaled2floatX(inti)

Same as scaled2float(int, int) using the graph's x scale.

Parameters:
iThe scaled value to convert to a floating point value.
Returns:

The unscaled value.

Note

For internal use.

scaled2floatY

FORCE_INLINE_FUNCTION float scaled2floatY(inti)

Same as scaled2float(int, int) using the graph's y scale.

Parameters:
iThe scaled value to convert to a floating point value.
Returns:

The unscaled value.

Note

For internal use.

scaled2intX

FORCE_INLINE_FUNCTION int scaled2intX(inti)

Same as scaled2int(int, int) using the graph's x scale.

Parameters:
iThe scaled value to convert to an integer.
Returns:

The unscaled value.

Note

For internal use.

scaled2intY

FORCE_INLINE_FUNCTION int scaled2intY(inti)

Same as scaled2int(int, int) using the graph's y scale.

Parameters:
iThe scaled value to convert to an integer.
Returns:

The unscaled value.

Note

For internal use.

setAlpha

virtual void setAlpha(uint8_tnewAlpha)

Sets the opacity (alpha value).

This can be used to fade it away by gradually decreasing the alpha value from 255 (solid) to 0 (invisible).

Parameters:
newAlphaThe new alpha value. 255=solid, 0=invisible.
Note

The user code must call invalidate() in order to update the display.All graph elements have to take this alpha into consideration.

See also:

setClickAction

FORCE_INLINE_FUNCTION void setClickAction(GenericCallback< const AbstractDataGraph &, const GraphClickEvent & > &callback)

Sets an action to be executed when the graph is clicked.

Parameters:
callbackThe callback.
See also:

setDragAction

FORCE_INLINE_FUNCTION void setDragAction(GenericCallback< const AbstractDataGraph &, const GraphDragEvent & > &callback)

Sets an action to be executed when the graph is dragged.

Parameters:
callbackThe callback.
See also:

setGapBeforeIndex

FORCE_INLINE_FUNCTION void setGapBeforeIndex(int16_tindex)

Makes gap before the specified index.

This can be used to split a graph in two, but for some graph types, e.g. histograms, this has no effect. Only one gap can be specified at a time. Specifying a new gap automatically removes the previous gap.

Parameters:
indexZero-based index where the gap should be placed.

setGraphAreaMargin

void setGraphAreaMargin(int16_ttop ,
int16_tleft ,
int16_tright ,
int16_tbottom
)

Sets graph position inside the widget by reserving a margin around the graph.

These areas to the left, the right, above and below are used for drawing optional axis and titles.

Parameters:
topThe top margin in pixels.
leftThe left margin in pixels.
rightThe right margin in pixels.
bottomThe bottom margin in pixels.
Note

The graph is automatically invalidated when the graph margins are changed.

See also:

setGraphAreaPadding

void setGraphAreaPadding(int16_ttop ,
int16_tleft ,
int16_tright ,
int16_tbottom
)

Adds padding around the graph that will not be drawn in (apart from dots, boxes, lines etc.

that extend around the actual data point). The set padding will also work to make a gap between the graph and any labels that might have been added to the graph. To reserve an area that the graph will not be drawn in, use setGraphAreaMargin.

Parameters:
topThe top padding in pixels.
leftThe left padding in pixels.
rightThe right padding in pixels.
bottomThe bottom padding in pixels.
Note

The graph is automatically invalidated when the margins are set.

See also:

setGraphRange

FORCE_INLINE_FUNCTION void setGraphRange(floatxMin ,
floatxMax ,
floatyMin ,
floatyMax
)

Sets minimum and maximum x and y coordinate ranges for the graph.

This can be used to zoom in or out and only show parts of the graph. The range given is scaled.

Parameters:
xMinThe minimum x value.
xMaxThe maximum x value.
yMinThe minimum y value.
yMaxThe maximum y value.
See also:

setGraphRange

FORCE_INLINE_FUNCTION void setGraphRange(floatxMin ,
floatxMax ,
intyMin ,
intyMax
)

Sets minimum and maximum x and y coordinate ranges for the graph.

This can be used to zoom in or out and only show parts of the graph. The range given is scaled.

Parameters:
xMinThe minimum x value.
xMaxThe maximum x value.
yMinThe minimum y value.
yMaxThe maximum y value.
See also:

setGraphRange

FORCE_INLINE_FUNCTION void setGraphRange(intxMin ,
intxMax ,
floatyMin ,
floatyMax
)

Sets minimum and maximum x and y coordinate ranges for the graph.

This can be used to zoom in or out and only show parts of the graph. The range given is scaled.

Parameters:
xMinThe minimum x value.
xMaxThe maximum x value.
yMinThe minimum y value.
yMaxThe maximum y value.
See also:

setGraphRange

FORCE_INLINE_FUNCTION void setGraphRange(intxMin ,
intxMax ,
intyMin ,
intyMax
)

Sets minimum and maximum x and y coordinate ranges for the graph.

This can be used to zoom in or out and only show parts of the graph. The range given is scaled.

Parameters:
xMinThe minimum x value.
xMaxThe maximum x value.
yMinThe minimum y value.
yMaxThe maximum y value.
See also:

setGraphRangeScaled

FORCE_INLINE_FUNCTION void setGraphRangeScaled(intxMin ,
intxMax ,
intyMin ,
intyMax
)

Same as setGraphRange(int, int, int, int) except the passed arguments are assumed scaled.

This means that if the scale is 1000, a value of 1 is interpreted as 0.001 (i.e. 1/1000).

Parameters:
xMinThe minimum x value.
xMaxThe maximum x value.
yMinThe minimum y value.
yMaxThe maximum y value.
See also:

setGraphRangeX

virtual void setGraphRangeX(floatmin ,
floatmax
)

Sets minimum and maximum x coordinates for the graph.

This can be used to zoom in or out and only show parts of the graph.

Parameters:
minThe minimum x value.
maxThe maximum x value.
Note

The graph as well as the area above and below are automatically redrawn (invalidated).

setGraphRangeX

virtual void setGraphRangeX(intmin ,
intmax
)

Sets minimum and maximum x coordinates for the graph.

This can be used to zoom in or out and only show parts of the graph.

Parameters:
minThe minimum x value.
maxThe maximum x value.
Note

The graph as well as the area above and below are automatically redrawn (invalidated).

setGraphRangeXAuto

virtual void setGraphRangeXAuto(boolshowYaxis ,
floatmargin
)

Automatically adjust min and max x coordinate to show entire graph.

It is possible to ensure that the y axis (i.e. x=0) is included in the new range. If the graph range is changed as a consequence of calling this function, the graph is automatically redrawn (invalidated).

Parameters:
showYaxis(Optional) True to ensure that the y axis is visible (default is true).
margin(Optional) The margin to add above/below the max/min x value (default is no margin).
Note

This takes the currently visible y coordinate range into account. If data in the graph is changed, added or deleted, the graph range is not automatically recalculated. Call this function again to achieve this functionality.

See also:

setGraphRangeXAuto

virtual void setGraphRangeXAuto(boolshowYaxis =true,
intmargin =0
)

Automatically adjust min and max x coordinate to show entire graph.

It is possible to ensure that the y axis (i.e. x=0) is included in the new range. If the graph range is changed as a consequence of calling this function, the graph is automatically redrawn (invalidated).

Parameters:
showYaxis(Optional) True to ensure that the y axis is visible (default is true).
margin(Optional) The margin to add above/below the max/min x value (default is no margin).
Note

This takes the currently visible y coordinate range into account. If data in the graph is changed, added or deleted, the graph range is not automatically recalculated. Call this function again to achieve this functionality.

See also:

setGraphRangeXAutoScaled

virtual void setGraphRangeXAutoScaled(boolshowYaxis ,=0
intmargin=0
)=0

Automatically adjust min and max x coordinate to show entire graph.

It is possible to ensure that the y axis (i.e. x=0) is included in the new range. If the graph range is changed as a consequence of calling this function, the graph is automatically redrawn (invalidated).

Parameters:
showYaxis(Optional) True to ensure that the y axis is visible (default is true).
margin(Optional) The margin to add above/below the max/min x value (default is no margin).
Note

This takes the currently visible y coordinate range into account. If data in the graph is changed, added or deleted, the graph range is not automatically recalculated. Call this function again to achieve this functionality.The arguments are assumed scaled. This means that if the scale is 1000, a value of 1 is interpreted as 0.001 (i.e. 1/1000).

See also:

Reimplemented by: touchgfx::StaticDataGraph::setGraphRangeXAutoScaled, touchgfx::DynamicDataGraph::setGraphRangeXAutoScaled

setGraphRangeXScaled

virtual void setGraphRangeXScaled(intmin ,
intmax
)

Sets minimum and maximum x coordinates for the graph.

This can be used to zoom in or out and only show parts of the graph.

Parameters:
minThe minimum x value.
maxThe maximum x value.
Note

The graph as well as the area above and below are automatically redrawn (invalidated).The arguments are assumed scaled. This means that if the scale is 1000, a value of 1 is interpreted as 0.001 (i.e. 1/1000).

See also:

setGraphRangeY

virtual void setGraphRangeY(floatmin ,
floatmax
)

Sets minimum and maximum y coordinates for the graph.

This can be used to zoom in or out and only show parts of the graph.

Parameters:
minThe minimum y value.
maxThe maximum y value.
Note

The graph as well as the area to the left and to the right of the graph are automatically redrawn (invalidated)

setGraphRangeY

virtual void setGraphRangeY(intmin ,
intmax
)

Sets minimum and maximum y coordinates for the graph.

This can be used to zoom in or out and only show parts of the graph.

Parameters:
minThe minimum y value.
maxThe maximum y value.
Note

The graph as well as the area to the left and to the right of the graph are automatically redrawn (invalidated)

setGraphRangeYAuto

virtual void setGraphRangeYAuto(boolshowXaxis ,
floatmargin
)

Automatic adjust min and max y coordinate to show entire graph.

It is possible to ensure that the x axis (i.e. y=0) is included in the new range. If the graph range is changed, the graph is automatically redrawn (invalidated).

Parameters:
showXaxisTrue to ensure that the x axis is visible (default is true).
marginThe margin to add above/below the max/min y value (default is no margin).
Note

This takes the current visible x coordinate range into account.

setGraphRangeYAuto

virtual void setGraphRangeYAuto(boolshowXaxis =true,
intmargin =0
)

Automatic adjust min and max y coordinate to show entire graph.

It is possible to ensure that the x axis (i.e. y=0) is included in the new range. If the graph range is changed, the graph is automatically redrawn (invalidated).

Parameters:
showXaxisTrue to ensure that the x axis is visible (default is true).
marginThe margin to add above/below the max/min y value (default is no margin).
Note

This takes the current visible x coordinate range into account.

setGraphRangeYAutoScaled

virtual void setGraphRangeYAutoScaled(boolshowXaxis ,=0
intmargin=0
)=0

Automatic adjust min and max y coordinate to show entire graph.

It is possible to ensure that the x axis (i.e. y=0) is included in the new range. If the graph range is changed, the graph is automatically redrawn (invalidated).

Parameters:
showXaxisTrue to ensure that the x axis is visible (default is true).
marginThe margin to add above/below the max/min y value (default is no margin).
Note

This takes the current visible x coordinate range into account.

Reimplemented by: touchgfx::DynamicDataGraph::setGraphRangeYAutoScaled, touchgfx::StaticDataGraph::setGraphRangeYAutoScaled

setGraphRangeYScaled

virtual void setGraphRangeYScaled(intmin ,
intmax
)

Same as setGraphRangeY(int, int) except the passed arguments are assumed scaled.

Parameters:
minThe minimum y value.
maxThe maximum y value.
See also:

setHeight

virtual void setHeight(int16_theight)

Sets the height of this drawable.

Parameters:
heightThe new height.
Note

For most Drawable widgets, changing this does normally not automatically yield a redraw.

Reimplements: touchgfx::Drawable::setHeight

setScaleX

virtual void setScaleX(intscale ,
boolupdateData =false
)

Sets a scaling factor to be multiplied on each X value added.

Since the graph only stores integer values internally, it is possible to set a scale to e.g. 1000 and make the graph work as if there are three digits of precision. The addDataPoint() will multiply the x argument with the scaling factor and store this value. Please note the addDataPointScaled, which allows adding a value that is assumed to have already been multiplied by the scaling factor. Other functions exist in a "scaled" version where the arguments are assumed to already be scaled.

By setting the scale to 1 it is possible to simply use integer values for the graph.

Parameters:
scaleThe scaling factor.
updateData(Optional) True to update all existing x value.
See also:

Reimplemented by: touchgfx::DynamicDataGraph::setScaleX, touchgfx::StaticDataGraph::setScaleX

setScaleY

virtual void setScaleY(intscale ,
boolupdateData =false
)

Sets a scaling factor to be multiplied on each Y value added.

Since the graph only stores integer values internally, it is possible to set a scale to e.g. 1000 and make the graph work as if there are three digits of precision. The addDataPoint() will multiply the y argument with the scaling factor and store this value. Please note the addDataPointScaled, which allows adding a value that is assumed to have already been multiplied by the scaling factor. Other functions exist in a "scaled" version where the arguments are assumed to already be scaled.

By setting the scale to 1 it is possible to simply use integer values for the graph.

Parameters:
scaleThe scaling factor.
updateData(Optional) True to update all existing y value.
See also:

Reimplemented by: touchgfx::DynamicDataGraph::setScaleY, touchgfx::StaticDataGraph::setScaleY

setWidth

virtual void setWidth(int16_twidth)

Sets the width of this drawable.

Parameters:
widthThe new width.
Note

For most Drawable widgets, changing this does normally not automatically yield a redraw.

Reimplements: touchgfx::Drawable::setWidth

convertToNewScale

static int convertToNewScale(intvalue ,
intoldScale ,
intnewScale
)

Converts a value from one scale to another scale.

This would convert eg. 21 in scale 10 to 210 in scale 100 or to 2 in scale 1.

Parameters:
valueThe value to convert to another scale.
oldScaleThe old (current) scale of the value.
newScaleThe new scale that the value should be converted to.
Returns:

The given data converted to a new scale.

float2scaled

static FORCE_INLINE_FUNCTION int float2scaled(floatf ,
intscale
)

Multiply a floating point value with a constant and round the result.

Parameters:
fthe value to scale.
scaleThe scale.
Returns:

The product of the two numbers, rounded to nearest integer value.

int2scaled

static FORCE_INLINE_FUNCTION int int2scaled(inti ,
intscale
)

Multiply an integer value with a constant.

Parameters:
ithe value to scale.
scaleThe scale.
Returns:

The product of the two numbers.

scaled2float

static FORCE_INLINE_FUNCTION float scaled2float(inti ,
intscale
)

Divide a floating point number with a constant.

Parameters:
iThe number to divide.
scaleThe divisor (scale).
Returns:

The number divided by the scale.

scaled2int

static FORCE_INLINE_FUNCTION int scaled2int(inti ,
intscale
)

Divide an integer with a constant and round the result.

Parameters:
iThe number to divide.
scaleThe divisor (scale).
Returns:

The number divided by the scale, rounded to nearest integer.

Protected Functions Documentation

indexToScreenXQ5

virtual CWRUtil::Q5 indexToScreenXQ5(int16_tindex)

Gets screen x coordinate for a specific data point added to the graph.

Parameters:
indexThe index of the element to get the x coordinate for.
Returns:

The screen x coordinate for the specific data point.

Reimplemented by: touchgfx::DynamicDataGraph::indexToScreenXQ5, touchgfx::StaticDataGraph::indexToScreenXQ5

indexToScreenYQ5

virtual CWRUtil::Q5 indexToScreenYQ5(int16_tindex)

Gets screen y coordinate for a specific data point added to the graph.

Parameters:
indexThe index of the element to get the y coordinate for.
Returns:

The screen x coordinate for the specific data point.

Reimplemented by: touchgfx::DynamicDataGraph::indexToScreenYQ5, touchgfx::StaticDataGraph::indexToScreenYQ5

indexToXAxis

virtual int indexToXAxis(const intvalueScaled ,const =0
const intlabelScaledconst =0
)const =0

Convert the given valueScaled (index) to x axis value.

Parameters:
valueScaledThe value scaled.
labelScaledThe label scaled.
Returns:

The x axis value.

Reimplemented by: touchgfx::DynamicDataGraph::indexToXAxis, touchgfx::StaticDataGraph::indexToXAxis

invalidateAllXAxisPoints

Invalidate all x axis points.

Similar to invalidateXAxisPointAt, this function will iterate all visible x values and invalidate them in turn.

See also:

invalidateGraphArea

FORCE_INLINE_FUNCTION void invalidateGraphArea()const

Invalidate entire graph area (the center of the graph).

This is often useful when a graph is cleared or the X or Y range is changed.

invalidateGraphPointAt

void invalidateGraphPointAt(int16_tindex)

Invalidate point at a given index.

This will call the function invalidateGraphPointAt() on every element added to the graphArea which in turn is responsible for invalidating the part of the screen occupied by its element.

Parameters:
indexZero-based index of the element to invalidate.

invalidateXAxisPointAt

void invalidateXAxisPointAt(int16_tindex)

Invalidate x axis point at the given index.

Since the y axis is often static, the x axis can change, and all labels need to be updated without redrawing the entire graph.

Parameters:
indexThe x index to invalidate.
See also:

updateAreasPosition

Updates the position of all elements in all area after a change in size of the graph area and/or label padding.

Note

The entire graph area is invalidated.

valueToScreenXQ5

virtual CWRUtil::Q5 valueToScreenXQ5(intx)

Gets screen x coordinate for an absolute value.

Parameters:
xThe x value.
Returns:

The screen x coordinate for the given value.

valueToScreenYQ5

virtual CWRUtil::Q5 valueToScreenYQ5(inty)

Gets screen y coordinate for an absolute value.

Parameters:
yThe y value.
Returns:

The screen y coordinate for the given value.

xScreenRangeToIndexRange

virtual bool xScreenRangeToIndexRange(int16_txMin ,const =0
int16_txMax ,const =0
int16_t &indexMin ,const =0
int16_t &indexMaxconst =0
)const =0

Gets index range for screen x coordinate range taking the current graph range into account.

Parameters:
xMinThe low screen x coordinate.
xMaxThe high screen x coordinate.
indexMinThe low element index.
indexMaxThe high element index.
Returns:

True if the range from low index to high index is legal.

Note

For internal use.

Reimplemented by: touchgfx::DynamicDataGraph::xScreenRangeToIndexRange, touchgfx::StaticDataGraph::xScreenRangeToIndexRange

Protected Attributes Documentation

alpha

uint8_t alpha

The alpha of the entire graph.

bottomArea

Container bottomArea

The area below the graph.

bottomPadding

int16_t bottomPadding

The graph area bottom padding.

clickAction

GenericCallback< const AbstractDataGraph &, const GraphClickEvent & > * clickAction

The callback to be executed when this Graph is clicked.

dragAction

GenericCallback< const AbstractDataGraph &, const GraphDragEvent & > * dragAction

The callback to be executed when this Graph is dragged.

gapBeforeIndex

int16_t gapBeforeIndex

The graph is disconnected (there is a gap) before this element index.

graphArea

Container graphArea

The graph area (the center area)

graphRangeMaxX

int graphRangeMaxX

The graph range maximum x coordinate.

graphRangeMaxY

int graphRangeMaxY

The graph range maximum y coordinate.

graphRangeMinX

int graphRangeMinX

The graph range minimum x coordinate.

graphRangeMinY

int graphRangeMinY

The graph range minimum y coordinate.

leftArea

Container leftArea

The area to the left of the graph.

leftPadding

int16_t leftPadding

The graph area left padding.

maxCapacity

int16_t maxCapacity

Maximum number of points in the graph.

rightArea

Container rightArea

The area to the right of the graph.

rightPadding

int16_t rightPadding

The graph area right padding.

topArea

Container topArea

The area above the graph.

topPadding

int16_t topPadding

The graph area top padding.

usedCapacity

int16_t usedCapacity

The number of used points in the graph.

xScale

int xScale

The data scale for the x values.

yScale

int yScale

The data scale for the y values.