Skip to main content

GraphTitle

The GraphTitle is just a simple text, but it is automatically moved with the graph. Also, the alpha value is combined with the alpha of the graph and so it will be faded if the graph is faded.

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

Public Functions

virtual voiddraw(const Rect & invalidatedArea) const
Draws the given invalidated area.
virtual booldrawCanvasWidget(const Rect & invalidatedArea) const
Draw canvas widget for the given invalidated area.
TextRotationgetTitleRotation() const
Gets title rotation.
TypedTextgetTitleTypedText() const
Gets title typed text.
GraphTitle()
virtual voidinvalidateGraphPointAt(int16_t index)
Invalidate the point at the given index.
voidsetTitleRotation(TextRotation rotation)
Sets TextRotation of the title.
voidsetTitleTypedText(const TypedText & typedText)
Sets TypedText to use as a title.

Additional inherited members

Public Functions inherited from AbstractGraphElementNoCWR

AbstractGraphElementNoCWR()
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 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

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

drawCanvasWidget

virtual bool drawCanvasWidget(const Rect &invalidatedArea)

Draw canvas widget for the given invalidated area.

Similar to draw(), but might be invoked several times with increasingly smaller areas to due to memory constraints from the underlying CanvasWidgetRenderer.

Parameters:
invalidatedAreaThe invalidated area.
Returns:

true if the widget was drawn properly, false if not.

See also:

Reimplements: touchgfx::AbstractGraphElementNoCWR::drawCanvasWidget

getTitleRotation

TextRotation getTitleRotation()const

Gets title rotation.

Returns:

The title rotation.

See also:

getTitleTypedText

TypedText getTitleTypedText()const

Gets title typed text.

Returns:

The title typed text.

See also:

GraphTitle

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

setTitleRotation

Sets TextRotation of the title.

Parameters:
rotationThe rotation.
See also:

setTitleTypedText

void setTitleTypedText(const TypedText &typedText)

Sets TypedText to use as a title.

It can be any static text which is just added as a title.

Parameters:
typedTextThe typed text.
See also: