/
VerticalOrigin.js
49 lines (46 loc) · 1.13 KB
/
VerticalOrigin.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
/**
* The vertical location of an origin relative to an object, e.g., a {@link Billboard}
* or {@link Label}. For example, setting the vertical origin to <code>TOP</code>
* or <code>BOTTOM</code> will display a billboard above or below (in screen space)
* the anchor position.
* <br /><br />
* <div align='center'>
* <img src='Images/Billboard.setVerticalOrigin.png' width='695' height='175' /><br />
* </div>
*
* @enum {number}
*
* @see Billboard#verticalOrigin
* @see Label#verticalOrigin
*/
const VerticalOrigin = {
/**
* The origin is at the vertical center between <code>BASELINE</code> and <code>TOP</code>.
*
* @type {number}
* @constant
*/
CENTER: 0,
/**
* The origin is at the bottom of the object.
*
* @type {number}
* @constant
*/
BOTTOM: 1,
/**
* If the object contains text, the origin is at the baseline of the text, else the origin is at the bottom of the object.
*
* @type {number}
* @constant
*/
BASELINE: 2,
/**
* The origin is at the top of the object.
*
* @type {number}
* @constant
*/
TOP: -1,
};
export default Object.freeze(VerticalOrigin);