Class: Format

Format

Contains visual parameters like fill, shadow, image, font.

new Format

Parameters:
Name Type Description
chart Tee.Chart The parent chart this format object belongs to.
Properties:
Name Type Description
gradient Tee.Gradient Gradient properties to fill contents.
fill Color Color used to paint contents interior.
stroke Tee.Stroke Properties to draw lines around boundaries.
shadow Tee.Shadow Properties to draw a backdrop shadow.
font Tee.Font Properties to fill text.
image Tee.ChartImage Image to fill background.
round Tee.Point Width and height of rectangle rounded corners.
transparency Number Controls the transparency, from 0 (opaque) to 1 (transparent).
Source:
  • ../../src/teechart.js, line 790

Methods

roundRect

Draws a rectangle with rounded corners

Parameters:
Name Type Argument Description
x Number Position in pixels of left side of rectangle.
y Number Position in pixels of top side of rectangle.
width Number Amount in pixels of rectangle width.
height Number Amount in pixels of rectangle height.
xr Number Amount in pixels of corners radius width.
yr Number Amount in pixels of corners radius height.
corners Boolean[] <optional>
Optional, defines to paint top-left, top-right, bottom-left and bottom-right corners.
Source:
  • ../../src/teechart.js, line 828

textHeight

Source:
  • ../../src/teechart.js, line 886
Returns:
Returns the height in pixels of a given text using current font size and attributes.
Type
Number

textWidth

Source:
  • ../../src/teechart.js, line 901
Returns:
Returns the width in pixels of a given text using current font size and attributes.
Type
Number