Skip to main content

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

virtual voiddraw(const Rect & invalidatedArea) const
Draws the given invalidated area.
virtual intgetCorrectlyScaledLabelInterval(const AbstractDataGraph * graph) const =0
Gets correctly scaled minor interval, as the minor label may have a scale that differs the scale of the graph and this label.
virtual 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.
FORCE_INLINE_FUNCTION floatgetIntervalAsFloat() const
Gets the interval between each label.
FORCE_INLINE_FUNCTION intgetIntervalAsInt() const
Gets the interval between each label.
FORCE_INLINE_FUNCTION intgetIntervalScaled() const
Gets the interval between each label.
FORCE_INLINE_FUNCTION Unicode::UnicodeChargetLabelDecimalPoint() const
Gets label decimal point previously set.
FORCE_INLINE_FUNCTION uint16_tgetLabelDecimals() const
Gets number of decimals for labels.
FORCE_INLINE_FUNCTION TextRotationgetLabelRotation() const
Gets label rotation.
FORCE_INLINE_FUNCTION TypedTextgetLabelTypedText() const
Gets TypedText label.
FORCE_INLINE_FUNCTION intgetScale() const
Gets the scaling factor set using setScale.
GraphLabelsBase()
virtual voidinvalidateGraphPointAt(int16_t index)
Invalidate the point at the given index.
FORCE_INLINE_FUNCTION voidsetInterval(float interval)
Sets the interval between each label.
FORCE_INLINE_FUNCTION voidsetInterval(int interval)
Sets the interval between each label.
FORCE_INLINE_FUNCTION voidsetIntervalScaled(int interval)
Sets the interval between each label.
FORCE_INLINE_FUNCTION voidsetLabelDecimalPoint(Unicode::UnicodeChar decimalPoint)
Sets label decimal point.
FORCE_INLINE_FUNCTION voidsetLabelDecimals(uint16_t decimals)
Sets number of decimals for labels, default is no decimals and no decimal point.
FORCE_INLINE_FUNCTION voidsetLabelRotation(TextRotation rotation)
Sets label rotation.
FORCE_INLINE_FUNCTION voidsetLabelTypedText(const TypedText & typedText)
Sets TypedText to use for the label.
FORCE_INLINE_FUNCTION voidsetMajorLabel(const GraphLabelsBase & major)
Sets "major" label that will be responsible for drawing major labels.
FORCE_INLINE_FUNCTION voidsetScale(int scale)
Sets a scaling factor to be multiplied on the labelInterval.

Protected Functions

virtual voiddrawIndexRange(const Rect & invalidatedArea, const Font fontToDraw, const AbstractDataGraph graph, const int rangeMin, const int rangeMax, const int minorInterval, const int majorInterval, const uint8_t a) const
Draw labels for all indexes in the given range.
virtual voiddrawString(const Rect & invalidatedArea, const Font fontToDraw, const AbstractDataGraph graph, const int valueScaled, const int labelScaled, const uint8_t a) const =0
Draw string.
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.
virtual intgetGraphRangeMaxScaled(const AbstractDataGraph * graph) const =0
Gets graph range maximum scaled.
virtual intgetGraphRangeMinScaled(const AbstractDataGraph * graph) const =0
Gets graph range minimum scaled.

Protected Attributes

intdataScale
The scaling factor.
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 & r) 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()
Default constructor.

Protected Functions inherited from AbstractGraphElement

FORCE_INLINE_FUNCTION intconvertToGraphScaleX(const AbstractDataGraph * graph, int value, int scale) const
Converts the value to the proper X scale of the graph.
FORCE_INLINE_FUNCTION intconvertToGraphScaleY(const AbstractDataGraph * graph, int value, int scale) const
Converts the value to the proper Y scale of the graph.
FORCE_INLINE_FUNCTION AbstractDataGraph *getGraph() const
Gets a pointer to the the graph containing the GraphElement.
FORCE_INLINE_FUNCTION intgetIndexToXAxis(const AbstractDataGraph * graph, const int valueScaled, const int labelScaled) const
Convert the given valueScaled (index) to x axis value.
FORCE_INLINE_FUNCTION CWRUtil::Q5indexToScreenXQ5(const AbstractDataGraph * graph, int16_t index) const
Gets screen x coordinate for a specific data point added to the graph.
FORCE_INLINE_FUNCTION 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.
FORCE_INLINE_FUNCTION 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.
FORCE_INLINE_FUNCTION CWRUtil::Q5valueToScreenXQ5(const AbstractDataGraph * graph, int x) const
Gets graph screen x for x value.
FORCE_INLINE_FUNCTION CWRUtil::Q5valueToScreenYQ5(const AbstractDataGraph * graph, int y) const
Gets graph screen y for y value.
FORCE_INLINE_FUNCTION boolxScreenRangeToIndexRange(const AbstractDataGraph * graph, int16_t xMin, int16_t xMax, int16_t & indexMin, int16_t & indexMax) const
Gets graph element range for screen x coordinate range.

Public Functions inherited from CanvasWidget

CanvasWidget()
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.

Protected Attributes inherited from CanvasWidget

uint8_talpha
The Alpha for this 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

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.
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 voidhandleClickEvent(const ClickEvent & event)
Defines the event handler interface for ClickEvents.
virtual voidhandleDragEvent(const DragEvent & event)
Defines the event handler interface for DragEvents.
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 voidinvalidateContent() const
Tell the framework that the contents of the 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

draw

virtual void draw(const Rect &invalidatedArea)

Draws the given invalidated area.

If the underlying CanvasWidgetRenderer fail to render the widget (if the widget is too complex), the invalidated area is cut into smaller slices (horizontally) which are then drawn separately. If drawing a single raster line fails, that line is considered too complex and skipped (it is left blank/transparent) and drawing continues on the next raster line.

If drawing has failed at least once, which means that the number of horizontal lines draw has been reduced, the number of successfully drawn horizontal lines is remembered for the next invocation of draw(). A future call to draw() would then start off with the reduced number of horizontal lines to prevent potentially drawing the canvas widget in vain, as happened previously in draw().

Parameters:
invalidatedAreaThe invalidated area.
Note

Subclasses of CanvasWidget should implement drawCanvasWidget(), not draw(). The term "too complex" means that the size of the buffer (assigned to CanvasWidgetRenderer using CanvasWidgetRenderer::setupBuffer()) is too small.

See also:

Reimplements: touchgfx::CanvasWidget::draw

getCorrectlyScaledLabelInterval

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

Parameters:
graphThe graph.
Returns:

The correctly scaled minor interval.

Reimplemented by: touchgfx::GraphLabelsX::getCorrectlyScaledLabelInterval, touchgfx::GraphLabelsY::getCorrectlyScaledLabelInterval

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.

getIntervalAsFloat

FORCE_INLINE_FUNCTION float getIntervalAsFloat()const

Gets the interval between each label.

Returns:

The interval between each label.

See also:

getIntervalAsInt

FORCE_INLINE_FUNCTION int getIntervalAsInt()const

Gets the interval between each label.

Returns:

The interval between each label.

See also:

getIntervalScaled

FORCE_INLINE_FUNCTION int getIntervalScaled()const

Gets the interval between each label.

Returns:

The interval between each label.

Note

The interval returned here is left unscaled.

See also:

getLabelDecimalPoint

FORCE_INLINE_FUNCTION Unicode::UnicodeChar getLabelDecimalPoint()const

Gets label decimal point previously set.

Returns:

The label decimal point.

See also:

getLabelDecimals

FORCE_INLINE_FUNCTION uint16_t getLabelDecimals()const

Gets number of decimals for labels.

Returns:

The number of label decimals.

getLabelRotation

FORCE_INLINE_FUNCTION TextRotation getLabelRotation()const

Gets label rotation.

Returns:

The label rotation.

See also:

getLabelTypedText

FORCE_INLINE_FUNCTION TypedText getLabelTypedText()const

Gets TypedText label.

Returns:

The label typed text.

See also:

getScale

FORCE_INLINE_FUNCTION int getScale()const

Gets the scaling factor set using setScale.

Returns:

The scaling factor.

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

FORCE_INLINE_FUNCTION 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

FORCE_INLINE_FUNCTION 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:

setIntervalScaled

FORCE_INLINE_FUNCTION 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.

See also:

setLabelDecimalPoint

FORCE_INLINE_FUNCTION void setLabelDecimalPoint(Unicode::UnicodeChardecimalPoint)

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

FORCE_INLINE_FUNCTION 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

FORCE_INLINE_FUNCTION void setLabelRotation(TextRotationrotation)

Sets label rotation.

Parameters:
rotationThe rotation or the text.
See also:

setLabelTypedText

FORCE_INLINE_FUNCTION 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

FORCE_INLINE_FUNCTION 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.

setScale

FORCE_INLINE_FUNCTION void setScale(intscale)

Sets a scaling factor to be multiplied on the labelInterval.

Any already set labelInterval will be updated to the new correctly scaled value. To avoid this, use setIntervalScaled after setting scale.

Parameters:
scaleThe scaling factor.
See also:

Protected Functions Documentation

drawIndexRange

virtual void drawIndexRange(const Rect &invalidatedArea ,const
const Font *fontToDraw ,const
const AbstractDataGraph *graph ,const
const intrangeMin ,const
const intrangeMax ,const
const intminorInterval ,const
const intmajorInterval ,const
const uint8_taconst
)const

Draw labels for all indexes in the given range.

This is used where there is a gap in the graph and the labels have to be drawn using different x scales.

Parameters:
invalidatedAreaThe canvas.
fontToDrawThe font to draw.
graphThe graph.
rangeMinThe minimum index.
rangeMaxThe maximum index.
minorIntervalThe minor interval.
majorIntervalThe major interval.
aThe alpha of the strings.

Reimplemented by: touchgfx::GraphLabelsX::drawIndexRange

drawString

virtual void drawString(const Rect &invalidatedArea ,const =0
const Font *fontToDraw ,const =0
const AbstractDataGraph *graph ,const =0
const intvalueScaled ,const =0
const intlabelScaled ,const =0
const uint8_taconst =0
)const =0

Draw string.

Parameters:
invalidatedAreaThe invalidated area.
fontToDrawThe font to draw.
graphThe graph.
valueScaledThe value scaled.
labelScaledThe label scaled.
aThe alpha of the string.

Reimplemented by: touchgfx::GraphLabelsX::drawString, touchgfx::GraphLabelsY::drawString

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.

getGraphRangeMaxScaled

virtual int getGraphRangeMaxScaled(const AbstractDataGraph *graph)

Gets graph range maximum scaled.

Parameters:
graphThe graph.
Returns:

The graph range maximum scaled.

Reimplemented by: touchgfx::GraphLabelsX::getGraphRangeMaxScaled, touchgfx::GraphLabelsY::getGraphRangeMaxScaled

getGraphRangeMinScaled

virtual int getGraphRangeMinScaled(const AbstractDataGraph *graph)

Gets graph range minimum scaled.

Parameters:
graphThe graph.
Returns:

The graph range minimum scaled.

Reimplemented by: touchgfx::GraphLabelsX::getGraphRangeMinScaled, touchgfx::GraphLabelsY::getGraphRangeMinScaled

Protected Attributes Documentation

dataScale

int dataScale

The scaling factor.

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.