-
Notifications
You must be signed in to change notification settings - Fork 83
/
ICacheConfiguration.ts
72 lines (66 loc) · 1.48 KB
/
ICacheConfiguration.ts
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
import {IComponentConfiguration} from "../../Component";
/**
* Interface for configuration of cache depth.
*
* @interface
* @example
* ```
* var viewer = new Mapillary.Viewer('<element-id>', '<client-id>', '<image-key>',
* {
* component: {
* cache: {
* depth: {
* pano: 2,
* sequence: 3,
* }
* },
* },
* })
* ```
*/
export interface ICacheDepth {
/**
* Cache depth in the sequence directions.
*
* @description Max value is 4. Value will be coerced
* to the interval [0, 4].
* @default 2
*/
sequence: number;
/**
* Cache depth in the pano direction.
*
* @description Max value is 2. Value will be coerced
* to the interval [0, 2].
* @default 1
*/
pano: number;
/**
* Cache depth in the step directions.
*
* @description Max value is 3. Value will be coerced
* to the interval [0, 3].
* @default 1
*/
step: number;
/**
* Cache depth in the turn directions.
*
* @description Max value is 1. Value will be coerced
* to the interval [0, 1].
* @default 0
*/
turn: number;
}
/**
* Interface for configuration of cache component.
*
* @interface
*/
export interface ICacheConfiguration extends IComponentConfiguration {
/**
* Cache depth struct.
*/
depth?: ICacheDepth;
}
export default ICacheConfiguration;