Class: Toybox.Graphics.Dc

Inherits:

Toybox.Lang.Object

• Toybox.Lang.Object
• Toybox.Graphics.Dc

Overview

This class represents a device context.

It provides methods to perform drawing operations on the device.

Note:

You should never directly instantiate a Dc object, or attempt to render to the screen outside of an onUpdate call.

Example:

Draws a blue rectangle using direct pixel parameters.

using Toybox.Graphics;
function onUpdate(dc) {
    dc.setColor(Graphics.COLOR_BLUE, Graphics.COLOR_BLACK);
    dc.fillRectangle(100, 100, 100, 100);
}

Example:

Draws a red circle using direct pixel parameters.

using Toybox.Graphics;
function onUpdate(dc) {
    dc.setColor(Graphics.COLOR_RED, Graphics.COLOR_BLACK);
    dc.fillCircle(50, 100, 75);
}

Example:

Draws "Hello World" in the center of the screen using calls to the Device Context (dc).

using Toybox.Graphics;
function onUpdate(dc) {
    dc.setColor(Graphics.COLOR_BLACK, Graphics.COLOR_TRANSPARENT);
    dc.drawText(
        dc.getWidth() / 2,                      // gets the width of the device and divides by 2
        dc.getHeight() / 2,                     // gets the height of the device and divides by 2
        Graphics.FONT_LARGE,                    // sets the font size
        "Hello World",                          // the String to display
        Graphics.TEXT_JUSTIFY_CENTER            // sets the justification for the text
                );
}

Example:

Clears the screen of device with background color (Graphics.COLOR_BLACK).

using Toybox.Graphics;
function onUpdate(dc) {
    dc.setColor(Graphics.COLOR_BLACK, Graphics.COLOR_BLACK);
    dc.clear();
}

Since:

API Level 1.0.0

Instance Method Summary

• clear() as Void

  Erase the screen using the background color.

• clearClip() as Void

  Reset the drawable area to the full area of the Dc.

• drawAngledText(x as Lang.Numeric, y as Lang.Numeric, font as Graphics.VectorFont, text as Lang.String, justification as Graphics.TextJustification or Lang.Number, angle as Lang.Numeric) as Void

  Draw angled text Draw text such that it is oriented perpendicular to a radial line at the given angle.

• drawArc(x as Lang.Numeric, y as Lang.Numeric, r as Lang.Numeric, attr as Graphics.ArcDirection, degreeStart as Lang.Numeric, degreeEnd as Lang.Numeric) as Void

  Draw an arc.

• drawBitmap(x as Lang.Numeric, y as Lang.Numeric, bitmap as Graphics.BitmapType) as Void

  Draw a bitmap to the screen.

• drawBitmap2(x as Lang.Numeric, y as Lang.Numeric, bitmap as Graphics.BitmapType, options as { :bitmapX as Lang.Number, :bitmapY as Lang.Number, :bitmapWidth as Lang.Number, :bitmapHeight as Lang.Number, :tintColor as Graphics.ColorType, :filterMode as Graphics.FilterMode, :transform as Graphics.AffineTransform } or Null) as Void

  Draw bitmap with the given options.

• drawCircle(x as Lang.Numeric, y as Lang.Numeric, radius as Lang.Numeric) as Void

  Draw a circle around a point.

• drawEllipse(x as Lang.Numeric, y as Lang.Numeric, a as Lang.Numeric, b as Lang.Numeric) as Void

  Draw an ellipse around a point.

• drawLine(x1 as Lang.Numeric, y1 as Lang.Numeric, x2 as Lang.Numeric, y2 as Lang.Numeric) as Void

  Draw a line between two points.

• drawOffsetBitmap(x as Lang.Numeric, y as Lang.Numeric, bitmapX as Lang.Numeric, bitmapY as Lang.Numeric, bitmapWidth as Lang.Numeric, bitmapHeight as Lang.Numeric, bitmap as Graphics.BitmapType) as Void

  Draw a bitmap to the screen with an offset.

• drawPoint(x as Lang.Numeric, y as Lang.Numeric) as Void

  Draw a point on the screen.

• drawRadialText(x as Lang.Numeric, y as Lang.Numeric, font as Graphics.VectorFont, text as Lang.String, justification as Graphics.TextJustification or Lang.Number, angle as Lang.Numeric, radius as Lang.Numeric, direction as Graphics.RadialTextDirection) as Void

  Draw radial text Draw text oriented along an arc.

• drawRectangle(x as Lang.Numeric, y as Lang.Numeric, width as Lang.Numeric, height as Lang.Numeric) as Void

  Draw a rectangle.

• drawRoundedRectangle(x as Lang.Numeric, y as Lang.Numeric, width as Lang.Numeric, height as Lang.Numeric, radius as Lang.Numeric) as Void

  Draw a rounded rectangle.

• drawScaledBitmap(x as Lang.Numeric, y as Lang.Numeric, width as Lang.Numeric, height as Lang.Numeric, bitmap as Graphics.BitmapType) as Void

  Draw a scaled bitmap to a surface.

• drawText(x as Lang.Numeric, y as Lang.Numeric, font as Graphics.FontType, text as Lang.Object or Null, justification as Graphics.TextJustification or Lang.Number) as Void

  Draw text at the given location.

• fillCircle(x as Lang.Numeric, y as Lang.Numeric, radius as Lang.Numeric) as Void

  Fill a circle with the foreground color.

• fillEllipse(x as Lang.Numeric, y as Lang.Numeric, a as Lang.Numeric, b as Lang.Numeric) as Void

  Fill an ellipse with the foreground color.

• fillPolygon(pts as Lang.Array<Graphics.Point2D>) as Void

  Fill a polygon with the foreground color.

• fillRectangle(x as Lang.Numeric, y as Lang.Numeric, width as Lang.Numeric, height as Lang.Numeric) as Void

  Fill a rectangle with the foreground color.

• fillRoundedRectangle(x as Lang.Numeric, y as Lang.Numeric, width as Lang.Numeric, height as Lang.Numeric, radius as Lang.Numeric) as Void

  Fill a rounded rectangle with the foreground color.

• getFontHeight(font as Graphics.FontType) as Lang.Number

  Get the height of a font.

• getHeight() as Lang.Number

  Get the height of the display region that is available to the app.

• getTextDimensions(text as Lang.String, font as Graphics.FontType) as [ Lang.Number, Lang.Number ]

  Get the width and height of a String.

• getTextWidthInPixels(text as Lang.String, font as Graphics.FontType) as Lang.Number

  Get the width of a String.

• getWidth() as Lang.Number

  Get the width of the display region that is available to the app.

• setAntiAlias(enabled as Lang.Boolean) as Void

  Enable anti-aliased drawing for primitives This method is not supported for a BufferedBitmap that has a palette.

• setBlendMode(mode as Graphics.BlendMode) as Void

  Set blend mode for drawing.

• setClip(x as Lang.Numeric, y as Lang.Numeric, width as Lang.Numeric, height as Lang.Numeric) as Void

  Apply a clipping region to the Dc.

• setColor(foreground as Graphics.ColorType, background as Graphics.ColorType) as Void

  Set the current foreground and background colors.

• setFill(fill as Lang.Number or Graphics.BitmapTexture) as Void

  Set fill tool for drawing primitives.

• setPenWidth(width as Lang.Numeric) as Void

  Set the width of a line.

• setStroke(stroke as Lang.Number or Graphics.BitmapTexture) as Void

  Set draw tool for drawing primitives.

Instance Method Details

clear() as Void

Erase the screen using the background color.

Note:

Starting form version 3.1.0, COLOR_TRANSPARENT will also be honored as background color, which will cause the value of pixels in the clip region to be replaced by COLOR_TRANSPARENT. For example, this can be used to clear the transparent overlay layer so animation background is visible.

Since:

API Level 1.0.0

clearClip() as Void

Reset the drawable area to the full area of the Dc.

Since:

API Level 2.3.0

drawAngledText(x as Lang.Numeric, y as Lang.Numeric, font as Graphics.VectorFont, text as Lang.String, justification as Graphics.TextJustification or Lang.Number, angle as Lang.Numeric) as Void

Draw angled text

Draw text such that it is oriented perpendicular to a radial line at the given angle.

Parameters:

• x — (Lang.Numeric) —

  The x location of the text

• y — (Lang.Numeric) —

  The y location of the text

• font — (Graphics.VectorFont) —

  The font to use.

• text — (Lang.String) —

  The String to render.

• justification — (Graphics.TextJustification, Lang.Number) —

  Specifies how text is placed relative to the text location.

• angle — (Lang.Numeric) —

  Angle of the text baseline in degrees counter-clockwise from the 3 o'clock position.

Supported Devices:

• Approach® S70 42mm
• Approach® S70 47mm
• D2™ Mach 1
• Descent™ Mk3 43mm / Mk3i 43mm
• Descent™ Mk3i 51mm
• Enduro™ 3
• epix™ (Gen 2) / quatix® 7 Sapphire
• epix™ Pro (Gen 2) 42mm
• epix™ Pro (Gen 2) 47mm / quatix® 7 Pro
• epix™ Pro (Gen 2) 51mm / D2™ Mach 1 Pro / tactix® 7 – AMOLED Edition
• fēnix® 7 / quatix® 7
• fēnix® 7 Pro - Solar Edition (no Wi-Fi)
• fēnix® 7 Pro
• fēnix® 7S Pro
• fēnix® 7S
• fēnix® 7X / tactix® 7 / quatix® 7X Solar / Enduro™ 2
• fēnix® 7X Pro - Solar Edition (no Wi-Fi)
• fēnix® 7X Pro
• fēnix® 8 43mm
• fēnix® 8 47mm / 51mm / tactix® 8 47mm / 51mm
• fēnix® 8 Solar 47mm
• fēnix® 8 Solar 51mm / tactix® 8 Solar 51mm
• fēnix® E
• Forerunner® 165 Music
• Forerunner® 165
• Forerunner® 265
• Forerunner® 265s
• Forerunner® 570 42mm
• Forerunner® 570 47mm
• Forerunner® 955 / Solar
• Forerunner® 965
• Forerunner® 970
• MARQ® (Gen 2) Athlete / Adventurer / Captain / Golfer / Carbon Edition / Commander - Carbon Edition
• MARQ® (Gen 2) Aviator
• Venu® 3
• Venu® 3S
• vívoactive® 6

Since:

API Level 4.2.1

drawArc(x as Lang.Numeric, y as Lang.Numeric, r as Lang.Numeric, attr as Graphics.ArcDirection, degreeStart as Lang.Numeric, degreeEnd as Lang.Numeric) as Void

Draw an arc.

• 0 degrees: 3 o'clock position.

• 90 degrees: 12 o'clock position.

• 180 degrees: 9 o'clock position.

• 270 degrees: 6 o'clock position.

Parameters:

• x — (Lang.Numeric) —

  The x location of the arc center

• y — (Lang.Numeric) —

  The y location of the arc center

• r — (Lang.Numeric) —

  The radius of the arc

• attr — (Graphics.ArcDirection) —

  Arc drawing attributes. (ARC_COUNTER_CLOCKWISE or ARC_CLOCKWISE)

• degreeStart — (Lang.Numeric) —

  The start angle of the arc by degrees.

• degreeEnd — (Lang.Numeric) —

  The end angle of the arc by degrees.

Since:

API Level 1.2.0

drawBitmap(x as Lang.Numeric, y as Lang.Numeric, bitmap as Graphics.BitmapType) as Void

Draw a bitmap to the screen.

Note:

BitmapReference is only supported in CIQ 4.0.0 and later

Parameters:

• x — (Lang.Numeric) —

  The top left x coordinate to begin the draw

• y — (Lang.Numeric) —

  The top left y coordinate to begin the draw

• bitmap — (WatchUi.BitmapResource, Graphics.BufferedBitmap, Graphics.BitmapReference) —

  The object to draw. The source color palette must be a subset of the destination color palette.

Since:

API Level 1.0.0

Throws:

• (Graphics.InvalidPaletteException) —

  Thrown if the source color palette is not a subset of the destination palette

drawBitmap2(x as Lang.Numeric, y as Lang.Numeric, bitmap as Graphics.BitmapType, options as { :bitmapX as Lang.Number, :bitmapY as Lang.Number, :bitmapWidth as Lang.Number, :bitmapHeight as Lang.Number, :tintColor as Graphics.ColorType, :filterMode as Graphics.FilterMode, :transform as Graphics.AffineTransform } or Null) as Void

Draw bitmap with the given options

Parameters:

• x — (Lang.Numeric) —

  The top left x coordinate to begin the draw

• y — (Lang.Numeric) —

  The top left y coordinate to begin the draw

• bitmap — (Lang.Object) —

  The BitmapResource or BufferedBitmap to render. The source color palette must be a subset of the destination color palette.

• options — (Lang.Dictionary) —

  A dictionary of options

  • :bitmapX — (Lang.Number) —

    The x coordinate of the top left corner of the source bitmap area. Default is 0

  • :bitmapY — (Lang.Number) —

    The y coordinate of the top left corner of the source bitmap area. Default is 0

  • :bitmapWidth — (Lang.Number) —

    The width of the source bitmap area. Default is bitmap.getWidth()

  • :bitmapHeight — (Lang.Number) —

    The height of the source bitmap area. Default is bitmap.getHeight()

  • :tintColor — (Graphics.ColorType) —

    Tint color to apply to the output If not provided, no tint is applied.

  • :filterMode — (Graphics.FilterMode) —

    Default is FILTER_MODE_POINT.

  • :transform — (Graphics.AffineTransform) —

    Transformation to apply to the source image when drawing it to the output. If not provided, no transform is applied.

Supported Devices:

• Approach® S50
• Approach® S70 42mm
• Approach® S70 47mm
• D2™ Air X10
• D2™ Mach 1
• Descent™ G2
• Descent™ Mk3 43mm / Mk3i 43mm
• Descent™ Mk3i 51mm
• Edge® 1040 / 1040 Solar
• Edge® 1050
• Edge® 540 / 540 Solar
• Edge® 840 / 840 Solar
• Edge® Explore 2
• Enduro™ 3
• epix™ (Gen 2) / quatix® 7 Sapphire
• epix™ Pro (Gen 2) 42mm
• epix™ Pro (Gen 2) 47mm / quatix® 7 Pro
• epix™ Pro (Gen 2) 51mm / D2™ Mach 1 Pro / tactix® 7 – AMOLED Edition
• fēnix® 7 / quatix® 7
• fēnix® 7 Pro - Solar Edition (no Wi-Fi)
• fēnix® 7 Pro
• fēnix® 7S Pro
• fēnix® 7S
• fēnix® 7X / tactix® 7 / quatix® 7X Solar / Enduro™ 2
• fēnix® 7X Pro - Solar Edition (no Wi-Fi)
• fēnix® 7X Pro
• fēnix® 8 43mm
• fēnix® 8 47mm / 51mm / tactix® 8 47mm / 51mm
• fēnix® 8 Solar 47mm
• fēnix® 8 Solar 51mm / tactix® 8 Solar 51mm
• fēnix® E
• Forerunner® 165 Music
• Forerunner® 165
• Forerunner® 255 Music
• Forerunner® 255
• Forerunner® 255s Music
• Forerunner® 255s
• Forerunner® 265
• Forerunner® 265s
• Forerunner® 570 42mm
• Forerunner® 570 47mm
• Forerunner® 955 / Solar
• Forerunner® 965
• Forerunner® 970
• Instinct® 3 AMOLED 45mm
• Instinct® 3 AMOLED 50mm
• MARQ® (Gen 2) Athlete / Adventurer / Captain / Golfer / Carbon Edition / Commander - Carbon Edition
• MARQ® (Gen 2) Aviator
• Venu® 2 Plus
• Venu® 2
• Venu® 2S
• Venu® 3
• Venu® 3S
• Venu® Sq 2 Music
• Venu® Sq 2
• vívoactive® 5
• vívoactive® 6

Since:

API Level 4.2.1

Throws:

• InvalidValueException if one of :bitmapX, :bitmapY, :bitmapWidth, :bitmapHeight are provided and outside the bounds of bitmap.

drawCircle(x as Lang.Numeric, y as Lang.Numeric, radius as Lang.Numeric) as Void

Draw a circle around a point.

Parameters:

• x — (Lang.Numeric) —

  The x location of the circle center

• y — (Lang.Numeric) —

  The y location of the circle center

• radius — (Lang.Number) —

  The radius of the circle

Since:

API Level 1.0.0

drawEllipse(x as Lang.Numeric, y as Lang.Numeric, a as Lang.Numeric, b as Lang.Numeric) as Void

Draw an ellipse around a point.

Parameters:

• x — (Lang.Numeric) —

  The x location of the ellipse center

• y — (Lang.Numeric) —

  The y location of the ellipse center

• a — (Lang.Number) —

  The radius of the ellipse along the x axis

• b — (Lang.Number) —

  The radius of the ellipse along the y axis

Since:

API Level 1.0.0

drawLine(x1 as Lang.Numeric, y1 as Lang.Numeric, x2 as Lang.Numeric, y2 as Lang.Numeric) as Void

Draw a line between two points.

Parameters:

• x1 — (Lang.Numeric) —

  The first x coordinate

• y1 — (Lang.Numeric) —

  The first y coordinate

• x2 — (Lang.Numeric) —

  The second x coordinate

• y2 — (Lang.Numeric) —

  The second y coordinate

Since:

API Level 1.0.0

drawOffsetBitmap(x as Lang.Numeric, y as Lang.Numeric, bitmapX as Lang.Numeric, bitmapY as Lang.Numeric, bitmapWidth as Lang.Numeric, bitmapHeight as Lang.Numeric, bitmap as Graphics.BitmapType) as Void

Draw a bitmap to the screen with an offset.

Parameters:

• x — (Lang.Numeric) —

  The top left x coordinate to begin the draw

• y — (Lang.Numeric) —

  The top left y coordinate to begin the draw

• bitmapX — (Lang.Number) —

  The x offset of the upper left corner of pixels to copy from the bitmap.

• bitmapY — (Lang.Number) —

  The y offset of the upper left corner of pixels to copy from the bitmap.

• bitmapWidth — (Lang.Number) —

  The width of the area to copy pixels from the bitmap.

• bitmapHeight — (Lang.Number) —

  The height of the area to copy pixels from the bitmap

• bitmap — (Lang.Object) —

  The BitmapResource or BufferedBitmap to render. The source color palette must be a subset of the destination color palette.

Supported Devices:

• Approach® S70 42mm
• Approach® S70 47mm
• D2™ Air X10
• D2™ Mach 1
• Descent™ Mk3 43mm / Mk3i 43mm
• Descent™ Mk3i 51mm
• Enduro™ 3
• epix™ (Gen 2) / quatix® 7 Sapphire
• epix™ Pro (Gen 2) 42mm
• epix™ Pro (Gen 2) 47mm / quatix® 7 Pro
• epix™ Pro (Gen 2) 51mm / D2™ Mach 1 Pro / tactix® 7 – AMOLED Edition
• fēnix® 7 / quatix® 7
• fēnix® 7 Pro - Solar Edition (no Wi-Fi)
• fēnix® 7 Pro
• fēnix® 7S Pro
• fēnix® 7S
• fēnix® 7X / tactix® 7 / quatix® 7X Solar / Enduro™ 2
• fēnix® 7X Pro - Solar Edition (no Wi-Fi)
• fēnix® 7X Pro
• fēnix® 8 43mm
• fēnix® 8 47mm / 51mm / tactix® 8 47mm / 51mm
• fēnix® 8 Solar 47mm
• fēnix® 8 Solar 51mm / tactix® 8 Solar 51mm
• fēnix® E
• Forerunner® 265
• Forerunner® 265s
• Forerunner® 570 42mm
• Forerunner® 570 47mm
• Forerunner® 955 / Solar
• Forerunner® 965
• Forerunner® 970
• MARQ® (Gen 2) Athlete / Adventurer / Captain / Golfer / Carbon Edition / Commander - Carbon Edition
• MARQ® (Gen 2) Aviator
• Venu® 2 Plus
• Venu® 2
• Venu® 2S
• Venu® 3
• Venu® 3S
• vívoactive® 6

Since:

API Level 4.0.0

Throws:

• (Graphics.InvalidPaletteException) —

  Thrown if the source color palette is not a subset of the destination palette

drawPoint(x as Lang.Numeric, y as Lang.Numeric) as Void

Draw a point on the screen.

Parameters:

• x — (Lang.Numeric) —

  The x location of the point

• y — (Lang.Numeric) —

  The y location of the point

Since:

API Level 1.0.0

drawRadialText(x as Lang.Numeric, y as Lang.Numeric, font as Graphics.VectorFont, text as Lang.String, justification as Graphics.TextJustification or Lang.Number, angle as Lang.Numeric, radius as Lang.Numeric, direction as Graphics.RadialTextDirection) as Void

Draw radial text

Draw text oriented along an arc.

Parameters:

• x — (Lang.Numeric) —

  The x location of the center of circle for radial text

• y — (Lang.Numeric) —

  The y location of the center of circle for radial text

• font — (Graphics.VectorFont) —

  The font to use.

• text — (Lang.String) —

  The String to render.

• justification — (Graphics.TextJustification, Lang.Number) —

  Specifies how text placed relative to the text location.

• angle — (Lang.Numeric) —

  Angle to a point on the circle to justify text in degrees counter-clockwise from the 3 o'clock position.

• radius — (Lang.Numeric) —

  Distance from center of circle on which to draw text.

• direction — (Graphics.RadialTextDirection) —

  Text drawing direction along the arc.

Supported Devices:

• Approach® S70 42mm
• Approach® S70 47mm
• D2™ Mach 1
• Descent™ Mk3 43mm / Mk3i 43mm
• Descent™ Mk3i 51mm
• Enduro™ 3
• epix™ (Gen 2) / quatix® 7 Sapphire
• epix™ Pro (Gen 2) 42mm
• epix™ Pro (Gen 2) 47mm / quatix® 7 Pro
• epix™ Pro (Gen 2) 51mm / D2™ Mach 1 Pro / tactix® 7 – AMOLED Edition
• fēnix® 7 / quatix® 7
• fēnix® 7 Pro - Solar Edition (no Wi-Fi)
• fēnix® 7 Pro
• fēnix® 7S Pro
• fēnix® 7S
• fēnix® 7X / tactix® 7 / quatix® 7X Solar / Enduro™ 2
• fēnix® 7X Pro - Solar Edition (no Wi-Fi)
• fēnix® 7X Pro
• fēnix® 8 43mm
• fēnix® 8 47mm / 51mm / tactix® 8 47mm / 51mm
• fēnix® 8 Solar 47mm
• fēnix® 8 Solar 51mm / tactix® 8 Solar 51mm
• fēnix® E
• Forerunner® 165 Music
• Forerunner® 165
• Forerunner® 265
• Forerunner® 265s
• Forerunner® 570 42mm
• Forerunner® 570 47mm
• Forerunner® 955 / Solar
• Forerunner® 965
• Forerunner® 970
• MARQ® (Gen 2) Athlete / Adventurer / Captain / Golfer / Carbon Edition / Commander - Carbon Edition
• MARQ® (Gen 2) Aviator
• Venu® 3
• Venu® 3S
• vívoactive® 6

Since:

API Level 4.2.1

drawRectangle(x as Lang.Numeric, y as Lang.Numeric, width as Lang.Numeric, height as Lang.Numeric) as Void

Draw a rectangle.

Parameters:

• x — (Lang.Numeric) —

  The x location of the upper corner

• y — (Lang.Numeric) —

  The y location of the upper corner

• width — (Lang.Numeric) —

  The width value of the rectangle

• height — (Lang.Numeric) —

  The height value of the rectangle

Since:

API Level 1.0.0

drawRoundedRectangle(x as Lang.Numeric, y as Lang.Numeric, width as Lang.Numeric, height as Lang.Numeric, radius as Lang.Numeric) as Void

Draw a rounded rectangle.

Parameters:

• x — (Lang.Numeric) —

  The x location of the upper corner

• y — (Lang.Numeric) —

  The y location of the upper corner

• width — (Lang.Numeric) —

  The width value of the rectangle

• height — (Lang.Numeric) —

  The height value of the rectangle

• radius — (Lang.Numeric) —

  The radius of the rounding.

Since:

API Level 1.0.0

drawScaledBitmap(x as Lang.Numeric, y as Lang.Numeric, width as Lang.Numeric, height as Lang.Numeric, bitmap as Graphics.BitmapType) as Void

Draw a scaled bitmap to a surface.

Parameters:

• x — (Lang.Numeric) —

  The top left x coordinate to begin the draw

• y — (Lang.Numeric) —

  The top left y coordinate to begin the draw

• width — (Lang.Numeric) —

  The width of the bitmap drawn on the destination surface

• height — (Lang.Numeric) —

  The height of the bitmap drawn on the destination surface

• bitmap — (Lang.Object) —

  The BitmapResource or BufferedBitmap to render. The source color palette must be a subset of the destination color palette.

Supported Devices:

• Approach® S70 42mm
• Approach® S70 47mm
• D2™ Air X10
• D2™ Mach 1
• Descent™ Mk3 43mm / Mk3i 43mm
• Descent™ Mk3i 51mm
• Enduro™ 3
• epix™ (Gen 2) / quatix® 7 Sapphire
• epix™ Pro (Gen 2) 42mm
• epix™ Pro (Gen 2) 47mm / quatix® 7 Pro
• epix™ Pro (Gen 2) 51mm / D2™ Mach 1 Pro / tactix® 7 – AMOLED Edition
• fēnix® 7 / quatix® 7
• fēnix® 7 Pro - Solar Edition (no Wi-Fi)
• fēnix® 7 Pro
• fēnix® 7S Pro
• fēnix® 7S
• fēnix® 7X / tactix® 7 / quatix® 7X Solar / Enduro™ 2
• fēnix® 7X Pro - Solar Edition (no Wi-Fi)
• fēnix® 7X Pro
• fēnix® 8 43mm
• fēnix® 8 47mm / 51mm / tactix® 8 47mm / 51mm
• fēnix® 8 Solar 47mm
• fēnix® 8 Solar 51mm / tactix® 8 Solar 51mm
• fēnix® E
• Forerunner® 265
• Forerunner® 265s
• Forerunner® 570 42mm
• Forerunner® 570 47mm
• Forerunner® 955 / Solar
• Forerunner® 965
• Forerunner® 970
• MARQ® (Gen 2) Athlete / Adventurer / Captain / Golfer / Carbon Edition / Commander - Carbon Edition
• MARQ® (Gen 2) Aviator
• Venu® 2 Plus
• Venu® 2
• Venu® 2S
• Venu® 3
• Venu® 3S
• vívoactive® 6

Since:

API Level 4.0.0

Throws:

• (Graphics.InvalidPaletteException) —

  Thrown if the source color palette is not a subset of the destination palette

drawText(x as Lang.Numeric, y as Lang.Numeric, font as Graphics.FontType, text as Lang.Object or Null, justification as Graphics.TextJustification or Lang.Number) as Void

Draw text at the given location.

This method is not supported for anti-aliased fonts (including most built in fonts) for a BufferedBitmap that has a palette.

Note:

FontReference is only supported in CIQ 4.0.0 and later

Parameters:

• x — (Lang.Numeric) —

  The x location of the text

• y — (Lang.Numeric) —

  The y location of the text

• font — (Graphics.FontType) —

  The font to use. This can be a custom font loaded from resources or a Graphics.FONT_* value.

• text — (Lang.Object) —

  The Object to render.

• justification —

  Mask of Graphics.TEXT_JUSTIFY_* constants. This may either be a single Graphics.TEXT_JUSTIFY_* constant, or a combination of one vertical and one horizontal justification value as a bit mask (e.g., Graphics.TEXT_JUSTIFY_CENTER | Graphics.TEXT_JUSTIFY_VCENTER).

Since:

API Level 1.0.0

Throws:

• (Graphics.InvalidPaletteException) —

  Thrown if an anti-aliased font is used on a paletted bitmap

fillCircle(x as Lang.Numeric, y as Lang.Numeric, radius as Lang.Numeric) as Void

Fill a circle with the foreground color.

Parameters:

• x — (Lang.Numeric) —

  The x location of the circle center

• y — (Lang.Numeric) —

  The y location of the circle center

• radius — (Lang.Numeric) —

  The radius of the circle

Since:

API Level 1.0.0

fillEllipse(x as Lang.Numeric, y as Lang.Numeric, a as Lang.Numeric, b as Lang.Numeric) as Void

Fill an ellipse with the foreground color.

Parameters:

• x — (Lang.Numeric) —

  The x location of the ellipse center

• y — (Lang.Numeric) —

  The y location of the ellipse center

• a — (Lang.Numeric) —

  The radius of the ellipse along the x axis

• b — (Lang.Numeric) —

  The radius of the ellipse along the y axis

Since:

API Level 1.0.0

fillPolygon(pts as Lang.Array<Graphics.Point2D>) as Void

Fill a polygon with the foreground color.

Parameters:

• pts — (Lang.Array) —

  Array of coordinates with a 64 point limit

Since:

API Level 1.0.0

fillRectangle(x as Lang.Numeric, y as Lang.Numeric, width as Lang.Numeric, height as Lang.Numeric) as Void

Fill a rectangle with the foreground color.

Parameters:

• x — (Lang.Numeric) —

  The x location of the upper corner

• y — (Lang.Numeric) —

  The y location of the upper corner

• width — (Lang.Numeric) —

  The width value of the rectangle

• height — (Lang.Numeric) —

  The height value of the rectangle

Since:

API Level 1.0.0

fillRoundedRectangle(x as Lang.Numeric, y as Lang.Numeric, width as Lang.Numeric, height as Lang.Numeric, radius as Lang.Numeric) as Void

Fill a rounded rectangle with the foreground color.

Parameters:

• x — (Lang.Numeric) —

  The x location of the upper corner

• y — (Lang.Numeric) —

  The y location of the upper corner

• width — (Lang.Numeric) —

  The width value of the rectangle

• height — (Lang.Numeric) —

  The height value of the rectangle

• radius — (Lang.Numeric) —

  The radius of the rounding

Since:

API Level 1.0.0

getFontHeight(font as Graphics.FontType) as Lang.Number

Get the height of a font.

Parameters:

• font — (Graphics.FontType) —

  The font to measure

Returns:

• Lang.Number —

  The height of the font in pixels

Since:

API Level 1.0.0

getHeight() as Lang.Number

Get the height of the display region that is available to the app.

Returns:

• Lang.Number —

  The height of display in pixels

Since:

API Level 1.0.0

getTextDimensions(text as Lang.String, font as Graphics.FontType) as [ Lang.Number, Lang.Number ]

Get the width and height of a String.

This takes new lines into account when determining the height. The width is the maximum width for a given line of the String. If a String has two newline characters (\\n) in it, the height would be for three lines and the width would be the width of the longest String.

Parameters:

• text — (Lang.String) —

  The text to get the width for

• font — (Graphics.FontType) —

  The font of the text to measure.

Returns:

• Lang.Array —

  The [width, height] of the String in pixels

Since:

API Level 1.0.0

getTextWidthInPixels(text as Lang.String, font as Graphics.FontType) as Lang.Number

Get the width of a String.

Parameters:

• text — (Lang.String) —

  The text to get width for

• font — (Graphics.FontType) —

  The font of the text to measure.

Returns:

• Lang.Number —

  The width of String in pixels

Since:

API Level 1.0.0

getWidth() as Lang.Number

Get the width of the display region that is available to the app.

Returns:

• Lang.Number —

  The width of display in pixels

Since:

API Level 1.0.0

setAntiAlias(enabled as Lang.Boolean) as Void

Enable anti-aliased drawing for primitives This method is not supported for a BufferedBitmap that has a palette.

Parameters:

• enabled — (Lang.Boolean) —

  true if AA is to be enabled, false otherwise.

Supported Devices:

• Approach® S50
• Approach® S70 42mm
• Approach® S70 47mm
• Captain Marvel
• D2™ Air X10
• D2™ Air
• D2™ Mach 1
• Darth Vader™
• Descent™ G2
• Descent™ Mk2 / Descent™ Mk2i
• Descent™ Mk2 S
• Descent™ Mk3 43mm / Mk3i 43mm
• Descent™ Mk3i 51mm
• Edge® 1030 Plus
• Edge® 1030
• Edge® 1040 / 1040 Solar
• Edge® 1050
• Edge® 530
• Edge® 540 / 540 Solar
• Edge® 830
• Edge® 840 / 840 Solar
• Edge® Explore 2
• Enduro™ 3
• Enduro™
• epix™ (Gen 2) / quatix® 7 Sapphire
• epix™ Pro (Gen 2) 42mm
• epix™ Pro (Gen 2) 47mm / quatix® 7 Pro
• epix™ Pro (Gen 2) 51mm / D2™ Mach 1 Pro / tactix® 7 – AMOLED Edition
• fēnix® 5 Plus
• fēnix® 5S Plus
• fēnix® 5X Plus
• fēnix® 6 / 6 Solar / 6 Dual Power
• fēnix® 6 Pro / 6 Sapphire / 6 Pro Solar / 6 Pro Dual Power / quatix® 6
• fēnix® 6S / 6S Solar / 6S Dual Power
• fēnix® 6S Pro / 6S Sapphire / 6S Pro Solar / 6S Pro Dual Power
• fēnix® 6X Pro / 6X Sapphire / 6X Pro Solar / tactix® Delta Sapphire / Delta Solar / Delta Solar - Ballistics Edition / quatix® 6X / 6X Solar / 6X Dual Power
• fēnix® 7 / quatix® 7
• fēnix® 7 Pro - Solar Edition (no Wi-Fi)
• fēnix® 7 Pro
• fēnix® 7S Pro
• fēnix® 7S
• fēnix® 7X / tactix® 7 / quatix® 7X Solar / Enduro™ 2
• fēnix® 7X Pro - Solar Edition (no Wi-Fi)
• fēnix® 7X Pro
• fēnix® 8 43mm
• fēnix® 8 47mm / 51mm / tactix® 8 47mm / 51mm
• fēnix® 8 Solar 47mm
• fēnix® 8 Solar 51mm / tactix® 8 Solar 51mm
• fēnix® E
• First Avenger
• Forerunner® 165 Music
• Forerunner® 165
• Forerunner® 245 Music
• Forerunner® 245
• Forerunner® 255 Music
• Forerunner® 255
• Forerunner® 255s Music
• Forerunner® 255s
• Forerunner® 265
• Forerunner® 265s
• Forerunner® 570 42mm
• Forerunner® 570 47mm
• Forerunner® 645 Music
• Forerunner® 745
• Forerunner® 945 LTE
• Forerunner® 945
• Forerunner® 955 / Solar
• Forerunner® 965
• Forerunner® 970
• GPSMAP® 67 / 67i
• Instinct® 3 AMOLED 45mm
• Instinct® 3 AMOLED 50mm
• MARQ® (Gen 2) Athlete / Adventurer / Captain / Golfer / Carbon Edition / Commander - Carbon Edition
• MARQ® (Gen 2) Aviator
• MARQ® Adventurer
• MARQ® Athlete
• MARQ® Aviator
• MARQ® Captain / MARQ® Captain: American Magic Edition
• MARQ® Commander
• MARQ® Driver
• MARQ® Expedition
• MARQ® Golfer
• Montana® 7 Series
• Rey™
• Venu® 2 Plus
• Venu® 2
• Venu® 2S
• Venu® 3
• Venu® 3S
• Venu® Mercedes-Benz® Collection
• Venu® Sq 2 Music
• Venu® Sq 2
• Venu® Sq
• Venu® Sq. Music Edition
• Venu®
• vívoactive® 3 Music
• vívoactive® 4
• vívoactive® 4S
• vívoactive® 5
• vívoactive® 6

Since:

API Level 3.2.0

Throws:

• (Graphics.InvalidPaletteException) —

  Thrown if antialiasing is enabled for a paletted bitmap.

setBlendMode(mode as Graphics.BlendMode) as Void

Set blend mode for drawing.

Note:

BLEND_MODE_NO_BLEND is only supported while drawing bitmaps

Parameters:

• mode — (Graphics.BlendMode) —

  Graphics.BLEND_MODE_* constant.

Supported Devices:

• Approach® S70 42mm
• Approach® S70 47mm
• D2™ Air X10
• D2™ Mach 1
• Descent™ Mk3 43mm / Mk3i 43mm
• Descent™ Mk3i 51mm
• Enduro™ 3
• epix™ (Gen 2) / quatix® 7 Sapphire
• epix™ Pro (Gen 2) 42mm
• epix™ Pro (Gen 2) 47mm / quatix® 7 Pro
• epix™ Pro (Gen 2) 51mm / D2™ Mach 1 Pro / tactix® 7 – AMOLED Edition
• fēnix® 7 / quatix® 7
• fēnix® 7 Pro - Solar Edition (no Wi-Fi)
• fēnix® 7 Pro
• fēnix® 7S Pro
• fēnix® 7S
• fēnix® 7X / tactix® 7 / quatix® 7X Solar / Enduro™ 2
• fēnix® 7X Pro - Solar Edition (no Wi-Fi)
• fēnix® 7X Pro
• fēnix® 8 43mm
• fēnix® 8 47mm / 51mm / tactix® 8 47mm / 51mm
• fēnix® 8 Solar 47mm
• fēnix® 8 Solar 51mm / tactix® 8 Solar 51mm
• fēnix® E
• Forerunner® 265
• Forerunner® 265s
• Forerunner® 570 42mm
• Forerunner® 570 47mm
• Forerunner® 955 / Solar
• Forerunner® 965
• Forerunner® 970
• MARQ® (Gen 2) Athlete / Adventurer / Captain / Golfer / Carbon Edition / Commander - Carbon Edition
• MARQ® (Gen 2) Aviator
• Venu® 2 Plus
• Venu® 2
• Venu® 2S
• Venu® 3
• Venu® 3S
• vívoactive® 6

Since:

API Level 4.0.0

setClip(x as Lang.Numeric, y as Lang.Numeric, width as Lang.Numeric, height as Lang.Numeric) as Void

Apply a clipping region to the Dc.

Pixels outside of the region will not be affected by any operations.

Parameters:

• x — (Lang.Numeric) —

  The x coordinate of the top left corner of the clipping region

• y — (Lang.Numeric) —

  The y coordinate of the top left corner of the clipping region

• width — (Lang.Numeric) —

  The width of the clipping region in pixels.

• height — (Lang.Numeric) —

  The height of the clipping region in pixels.

Since:

API Level 2.3.0

setColor(foreground as Graphics.ColorType, background as Graphics.ColorType) as Void

Set the current foreground and background colors.

Parameters:

• foreground — (Graphics.ColorType) —

  Graphics.COLOR_* constant or 24-bit integer of the form 0xRRGGBB.

• background — (Graphics.ColorType) —

  Graphics.COLOR_* constant or 24-bit integer of the form 0xRRGGBB.

Since:

API Level 1.0.0

setFill(fill as Lang.Number or Graphics.BitmapTexture) as Void

Set fill tool for drawing primitives.

Note:

this function takes precedence over setColor(). If fill tool is not set, the foreground color will be used.

Parameters:

• fill — (Lang.Object) —

  The BitmapTexture or Color 32-bit integer in the format 0xAARRGGBB to use for fill draws.

Supported Devices:

• Approach® S70 42mm
• Approach® S70 47mm
• D2™ Air X10
• D2™ Mach 1
• Descent™ Mk3 43mm / Mk3i 43mm
• Descent™ Mk3i 51mm
• Enduro™ 3
• epix™ (Gen 2) / quatix® 7 Sapphire
• epix™ Pro (Gen 2) 42mm
• epix™ Pro (Gen 2) 47mm / quatix® 7 Pro
• epix™ Pro (Gen 2) 51mm / D2™ Mach 1 Pro / tactix® 7 – AMOLED Edition
• fēnix® 7 / quatix® 7
• fēnix® 7 Pro - Solar Edition (no Wi-Fi)
• fēnix® 7 Pro
• fēnix® 7S Pro
• fēnix® 7S
• fēnix® 7X / tactix® 7 / quatix® 7X Solar / Enduro™ 2
• fēnix® 7X Pro - Solar Edition (no Wi-Fi)
• fēnix® 7X Pro
• fēnix® 8 43mm
• fēnix® 8 47mm / 51mm / tactix® 8 47mm / 51mm
• fēnix® 8 Solar 47mm
• fēnix® 8 Solar 51mm / tactix® 8 Solar 51mm
• fēnix® E
• Forerunner® 265
• Forerunner® 265s
• Forerunner® 570 42mm
• Forerunner® 570 47mm
• Forerunner® 955 / Solar
• Forerunner® 965
• Forerunner® 970
• MARQ® (Gen 2) Athlete / Adventurer / Captain / Golfer / Carbon Edition / Commander - Carbon Edition
• MARQ® (Gen 2) Aviator
• Venu® 2 Plus
• Venu® 2
• Venu® 2S
• Venu® 3
• Venu® 3S
• vívoactive® 6

Since:

API Level 4.0.0

setPenWidth(width as Lang.Numeric) as Void

Set the width of a line.

Parameters:

• width — (Lang.Numeric) —

  The pen width in pixels

Since:

API Level 1.0.0

setStroke(stroke as Lang.Number or Graphics.BitmapTexture) as Void

Set draw tool for drawing primitives.

Note:

this function takes precedence over setColor(). If draw tool is not set, the foreground color will be used.

Parameters:

• stroke — (Lang.Object) —

  The BitmapTexture or Color 32-bit integer in the format 0xAARRGGBB to use for draws.

Supported Devices:

• Approach® S70 42mm
• Approach® S70 47mm
• D2™ Air X10
• D2™ Mach 1
• Descent™ Mk3 43mm / Mk3i 43mm
• Descent™ Mk3i 51mm
• Enduro™ 3
• epix™ (Gen 2) / quatix® 7 Sapphire
• epix™ Pro (Gen 2) 42mm
• epix™ Pro (Gen 2) 47mm / quatix® 7 Pro
• epix™ Pro (Gen 2) 51mm / D2™ Mach 1 Pro / tactix® 7 – AMOLED Edition
• fēnix® 7 / quatix® 7
• fēnix® 7 Pro - Solar Edition (no Wi-Fi)
• fēnix® 7 Pro
• fēnix® 7S Pro
• fēnix® 7S
• fēnix® 7X / tactix® 7 / quatix® 7X Solar / Enduro™ 2
• fēnix® 7X Pro - Solar Edition (no Wi-Fi)
• fēnix® 7X Pro
• fēnix® 8 43mm
• fēnix® 8 47mm / 51mm / tactix® 8 47mm / 51mm
• fēnix® 8 Solar 47mm
• fēnix® 8 Solar 51mm / tactix® 8 Solar 51mm
• fēnix® E
• Forerunner® 265
• Forerunner® 265s
• Forerunner® 570 42mm
• Forerunner® 570 47mm
• Forerunner® 955 / Solar
• Forerunner® 965
• Forerunner® 970
• MARQ® (Gen 2) Athlete / Adventurer / Captain / Golfer / Carbon Edition / Commander - Carbon Edition
• MARQ® (Gen 2) Aviator
• Venu® 2 Plus
• Venu® 2
• Venu® 2S
• Venu® 3
• Venu® 3S
• vívoactive® 6

Since:

API Level 4.0.0