Skip to main content
Version: 4.16

GraphLabelsBase

Helper class for adding labels on the side of a graph.

See: GraphLabelsX, GraphLabelsY

Inherits from: AbstractGraphDecoration, AbstractGraphElementNoCWR, AbstractGraphElement, CanvasWidget, Widget, Drawable

Inherited by: GraphLabelsX, GraphLabelsY

Public Functions#

floatgetIntervalAsFloat() const
Gets the interval between each label.
intgetIntervalAsInt() const
Gets the interval between each label.
Unicode::UnicodeChargetLabelDecimalPoint() const
Gets label decimal point previously set.
uint16_tgetLabelDecimals() const
Gets number of decimals for labels.
TextRotationgetLabelRotation() const
Gets label rotation.
TypedTextgetLabelTypedText() const
Gets TypedText label.
GraphLabelsBase()
virtual voidinvalidateGraphPointAt(int16_t index)
Invalidate the point at the given index.
voidsetInterval(float interval)
Sets the interval between each label.
voidsetInterval(int interval)
Sets the interval between each label.
voidsetLabelDecimalPoint(Unicode::UnicodeChar decimalPoint)
Sets label decimal point.
voidsetLabelDecimals(uint16_t decimals)
Sets number of decimals for labels, default is no decimals and no decimal point.
voidsetLabelRotation(TextRotation rotation)
Sets label rotation.
voidsetLabelTypedText(const TypedText & typedText)
Sets TypedText to use for the label.
voidsetMajorLabel(const GraphLabelsBase & major)
Sets "major" label that will be responsible for drawing major labels.

Protected Functions#

voidformatLabel(Unicode::UnicodeChar * buffer, int16_t bufferSize, int label, int decimals, Unicode::UnicodeChar decimalPoint, int scale) const
Format label according to the set number of decimals and the decimal point.
intgetCorrectlyScaledMajorInterval(const AbstractDataGraph * graph) const
Gets correctly scaled major interval, as the major label may have a scale that differs the scale of the graph and this label.
intgetIntervalScaled() const
Gets the interval between each label.
voidsetIntervalScaled(int interval)
Sets the interval between each label.

Protected Attributes#

Unicode::UnicodeCharlabelDecimalPoint
The label decimal point character.
uint16_tlabelDecimals
The number of decimals on the label.
intlabelInterval
The interval between each label.
TextRotationlabelRotation
The TextRotation to use for the label.
TypedTextlabelTypedText
The TypedText to use for the label.
const GraphLabelsBase *majorLabel
A pointer to a major label, if any.

Additional inherited members#

Public Functions inherited from AbstractGraphElementNoCWR#

AbstractGraphElementNoCWR()
virtual booldrawCanvasWidget(const Rect & invalidatedArea) const
Draw canvas widget for the given invalidated area.
virtual colortypegetColor() const
Gets the color of the graph element.
virtual voidsetColor(colortype newColor)
Sets the color of the graph element.

Protected Functions inherited from AbstractGraphElementNoCWR#

voidnormalizeRect(Rect & rect) const
Normalize rectangle by changing a rectangle with negative width or height to a rectangle with positive width or height at the correct position.
virtual voidsetPainter(AbstractPainter & painter)
Protected function to prevent users from setting a painter.

Protected Attributes inherited from AbstractGraphElementNoCWR#

colortypecolor
The currently assigned color.

Public Functions inherited from AbstractGraphElement#

AbstractGraphElement()
intgetScale() const
Gets the scaling factor set using setScale.
voidsetScale(int scale)
Sets a scaling factor to be multiplied on each added element.

Protected Functions inherited from AbstractGraphElement#

intconvertToGraphScale(const AbstractDataGraph * graph, int value, int scale) const
Converts a number with one scale to a number that has the same scale as the graph.
AbstractDataGraph *getGraph() const
Gets a pointer to the the graph containing the GraphElement.
intgetGraphRangeYMaxScaled(const AbstractDataGraph * graph) const
Gets maximum y coordinate for the graph.
intgetGraphRangeYMinScaled(const AbstractDataGraph * graph) const
Gets minimum y coordinate for the graph.
intgetGraphXAxisOffsetScaled(const AbstractDataGraph * graph) const
Get x axis offset as a scaled value.
intgetGraphXAxisScaleScaled(const AbstractDataGraph * graph) const
Get x axis scale as a scaled value.
CWRUtil::Q5indexToScreenXQ5(const AbstractDataGraph * graph, int16_t index) const
Gets screen x coordinate for a specific data point added to the graph.
CWRUtil::Q5indexToScreenYQ5(const AbstractDataGraph * graph, int16_t index) const
Gets screen y coordinate for a specific data point added to the graph.
boolisCenterInvisible(const AbstractDataGraph * graph, int16_t index) const
Query if the center of a given data point index is visible inside the graph area.
RectrectAround(CWRUtil::Q5 xQ5, CWRUtil::Q5 yQ5, CWRUtil::Q5 diameterQ5) const
Find the screen rectangle around a given point with the specified diameter.
RectrectFromQ5Coordinates(CWRUtil::Q5 screenXminQ5, CWRUtil::Q5 screenYminQ5, CWRUtil::Q5 screenXmaxQ5, CWRUtil::Q5 screenYmaxQ5) const
Find the screen rectangle containing the Q5 screen rectangle by rounding the coordinates up/down.
CWRUtil::Q5roundQ5(CWRUtil::Q5 q5) const
Round the given CWRUtil::Q5 to the nearest integer and return it as a CWRUtil::Q5 instead of an integer.
CWRUtil::Q5valueToScreenXQ5(const AbstractDataGraph * graph, int x) const
Gets graph screen x for x value.
CWRUtil::Q5valueToScreenYQ5(const AbstractDataGraph * graph, int y) const
Gets graph screen y for y value.
boolxScreenRangeToIndexRange(int16_t xLow, int16_t xHigh, int16_t & elementLow, int16_t & elementHigh) const
Gets graph element range for screen x coordinate range.

Protected Attributes inherited from AbstractGraphElement#

intdataScale
The scaling factor.

Public Functions inherited from CanvasWidget#

CanvasWidget()
virtual voiddraw(const Rect & invalidatedArea) const
Draws the given invalidated area.
virtual booldrawCanvasWidget(const Rect & invalidatedArea) const =0
Draw canvas widget for the given invalidated area.
virtual uint8_tgetAlpha() const
Gets the current alpha value of the widget.
virtual RectgetMinimalRect() const
Gets minimal rectangle containing the shape drawn by this widget.
virtual AbstractPainter &getPainter() const
Gets the current painter for the CanvasWidget.
virtual RectgetSolidRect() const
Gets the largest solid (non-transparent) rectangle.
virtual voidinvalidate() const
Invalidates the area covered by this CanvasWidget.
voidresetMaxRenderLines()
Resets the maximum render lines.
virtual voidsetAlpha(uint8_t newAlpha)
Sets the opacity (alpha value).
virtual voidsetPainter(AbstractPainter & painter)
Sets a painter for the CanvasWidget.

Public Functions inherited from Widget#

virtual voidgetLastChild(int16_t x, int16_t y, Drawable ** last)
Since a Widget is only one Drawable, Widget::getLastChild simply yields itself as result, but only if the Widget isVisible and isTouchable.

Public Functions inherited from Drawable#

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.
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 voidhandleClickEvent(const ClickEvent & evt)
Defines the event handler interface for ClickEvents.
virtual voidhandleDragEvent(const DragEvent & evt)
Defines the event handler interface for DragEvents.
virtual voidhandleGestureEvent(const GestureEvent & evt)
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.
virtual voidsetHeight(int16_t height)
Sets the height of this 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.
virtual voidsetWidth(int16_t width)
Sets the width of this drawable.
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 & rect)
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#

getIntervalAsFloat#

float getIntervalAsFloat()const

Gets the interval between each label.

Returns:

The interval between each label.

See also:

getIntervalAsInt#

int getIntervalAsInt()const

Gets the interval between each label.

Returns:

The interval between each label.

See also:

getLabelDecimalPoint#

Unicode::UnicodeChar getLabelDecimalPoint()const

Gets label decimal point previously set.

Returns:

The label decimal point.

See also:

getLabelDecimals#

uint16_t getLabelDecimals()const

Gets number of decimals for labels.

Returns:

The number of label decimals.

getLabelRotation#

TextRotation getLabelRotation()const

Gets label rotation.

Returns:

The label rotation.

See also:

getLabelTypedText#

TypedText getLabelTypedText()const

Gets TypedText label.

Returns:

The label typed text.

See also:

GraphLabelsBase#

invalidateGraphPointAt#

virtual void invalidateGraphPointAt(int16_tindex)

Invalidate the point at the given index.

This allows a graph element to only invalidate the minimum rectangle required for the given index. The Graph will call this function before and after changing a point to ensure that both the old and the new area are redrawn (invalidated).

Parameters:
indexZero-based index of the point.

Reimplements: touchgfx::AbstractGraphElement::invalidateGraphPointAt

Reimplemented by: touchgfx::GraphLabelsX::invalidateGraphPointAt

setInterval#

void setInterval(floatinterval)

Sets the interval between each label.

Parameters:
intervalThe interval between each label.
Note

If interval is 0 only the axis is shown.

See also:

setInterval#

void setInterval(intinterval)

Sets the interval between each label.

Parameters:
intervalThe interval between each label.
Note

If interval is 0 only the axis is shown.

See also:

setLabelDecimalPoint#

Sets label decimal point.

Default is to use '.' but this can be changed using this function.

Parameters:
decimalPointThe character to use for decimal point.
Note

The decimal point is only set if the label decimals > 0.

See also:

setLabelDecimals#

void setLabelDecimals(uint16_tdecimals)

Sets number of decimals for labels, default is no decimals and no decimal point.

Parameters:
decimalsThe number of label decimals.
See also:

setLabelRotation#

Sets label rotation.

Parameters:
rotationThe rotation or the text.
See also:

setLabelTypedText#

void setLabelTypedText(const TypedText &typedText)

Sets TypedText to use for the label.

The TypedText should contain exactly one wildcard.

Parameters:
typedTextThe typed text.
See also:

setMajorLabel#

void setMajorLabel(const GraphLabelsBase &major)

Sets "major" label that will be responsible for drawing major labels.

If a label would be drawn at the same position as the major label, the label will not be drawn.

Parameters:
majorReference to a major label object.

Protected Functions Documentation#

formatLabel#

void formatLabel(Unicode::UnicodeChar *buffer ,const
int16_tbufferSize ,const
intlabel ,const
intdecimals ,const
Unicode::UnicodeChardecimalPoint ,const
intscaleconst
)const

Format label according to the set number of decimals and the decimal point.

Parameters:
bufferThe buffer to fill with the formatted number.
bufferSizeSize of the buffer.
labelThe label value.
decimalsThe number of decimals.
decimalPointThe decimal point.
scaleThe scale of the label value.

getCorrectlyScaledMajorInterval#

Gets correctly scaled major interval, as the major label may have a scale that differs the scale of the graph and this label.

Parameters:
graphThe graph.
Returns:

The correctly scaled major interval.

getIntervalScaled#

int getIntervalScaled()const

Gets the interval between each label.

Returns:

The interval between each label.

Note

The interval returned here is left unscaled. For internal use.

See also:

setIntervalScaled#

void setIntervalScaled(intinterval)

Sets the interval between each label.

Parameters:
intervalThe interval between each label.
Note

If interval is 0 only the axis is shown.The interval set here must already be scaled. For internal use.

See also:

Protected Attributes Documentation#

labelDecimalPoint#

Unicode::UnicodeChar labelDecimalPoint

The label decimal point character.

labelDecimals#

uint16_t labelDecimals

The number of decimals on the label.

labelInterval#

int labelInterval

The interval between each label.

labelRotation#

TextRotation labelRotation

The TextRotation to use for the label.

labelTypedText#

TypedText labelTypedText

The TypedText to use for the label.

majorLabel#

const GraphLabelsBase * majorLabel

A pointer to a major label, if any.