/
FontExtents.js
55 lines (49 loc) · 1.86 KB
/
FontExtents.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
/* API Version - 3.1.2 */
/**
* Information about the dimensions of a font.
*
* @newSince API version 6
*/
function FontExtents() {}
/**
* Returns the distance that the font extends above the baseline. Note that this is not always
* exactly equal to the maximum of the extents of all the glyphs in the font, but rather is
* picked to express the font designer's intent as to how the font should align with elements
* above it.
*
* @return {double}
*/
FontExtents.prototype.getAscent = function() {};
/**
* Returns the distance that the font extends below the baseline. This value is positive for
* typical fonts that include portions below the baseline. Note that this is not always exactly
* equal to the maximum of the extents of all the glyphs in the font, but rather is picked to
* express the font designer's intent as to how the the font should align with elements below it.
*
* @return {double}
*/
FontExtents.prototype.getDescent = function() {};
/**
* Returns the recommended vertical distance between baselines when setting consecutive lines of
* text with the font. This is greater than ascent+descent by a quantity known as the line
* spacing or external leading. When space is at a premium, most fonts can be set with only a
* distance of ascent+descent between lines.
*
* @return {double}
*/
FontExtents.prototype.getHeight = function() {};
/**
* the maximum distance in the X direction that the the origin is advanced for any glyph in the
* font.
*
* @return {double}
*/
FontExtents.prototype.getMaxAdvanceX = function() {};
/**
* Returns the maximum distance in the Y direction that the the origin is advanced for any glyph
* in the font. this will be zero for normal fonts used for horizontal writing. (The scripts of
* East Asia are sometimes written vertically.)
*
* @return {double}
*/
FontExtents.prototype.getMaxAdvanceY = function() {};