new Tiny.TextMetrics(text, style, width, height, lines, lineWidths, lineHeight, maxLineWidth, fontProperties)
| Name | Type | Description |
|---|---|---|
text |
string |
the text that was measured |
style |
Tiny.TextStyle |
the style that was measured |
width |
number |
the measured width of the text |
height |
number |
the measured height of the text |
lines |
array |
an array of the lines of text broken by new lines and wrapping if specified in style |
lineWidths |
array |
an array of the line widths for each line matched to |
lineHeight |
number |
the measured line height for this style |
maxLineWidth |
number |
the maximum line width for all measured lines |
fontProperties |
object |
the font properties object from TextMetrics.measureFont |
Classes
Members
-
staticTiny.TextMetrics.BASELINE_MULTIPLIERnumber
-
Baseline multiplier for calculate font metrics.
- Version:
- 1.2.0
- Default Value:
- 1.4
-
staticTiny.TextMetrics.BASELINE_SYMBOLstring
-
Baseline symbol for calculate font metrics.
- Version:
- 1.2.0
- Default Value:
- M
-
staticTiny.TextMetrics.METRICS_STRINGstring
-
String used for calculate font metrics.
- Version:
- 1.2.0
- Default Value:
- |Éq
Methods
-
staticTiny.TextMetrics.clearMetrics(font)
-
Clear font metrics in metrics cache.
Name Type Description fontstring optional font name. If font name not set then clear cache for all fonts.
- Version:
- 1.2.0
-
staticTiny.TextMetrics.measureFont(font) ❯ {Tiny.TextMetrics~FontMetrics}
-
Calculates the ascent, descent and fontSize of a given font-style
Name Type Description fontstring String representing the style of the font
Returns:
Type Description Tiny.TextMetrics~FontMetrics Font properties object -
staticTiny.TextMetrics.measureText(text, style, wordWrap, canvas) ❯ {Tiny.TextMetrics}
-
Measures the supplied string of text and returns a Rectangle.
Name Type Description textstring the text to measure.
styleTiny.TextStyle the text style to use for measuring
wordWrapboolean optional optional override for if word-wrap should be applied to the text.
canvasHTMLCanvasElement optional optional specification of the canvas to use for measuring.
Returns:
Type Description Tiny.TextMetrics measured width and height of the text.