@jupytergis/schema 0.12.2 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/_interface/forms.json +90 -1
- package/lib/_interface/project/layers/storySegmentLayer.d.ts +49 -11
- package/lib/_interface/project/layers/vectorTileLayer.d.ts +11 -0
- package/lib/schema/project/layers/storySegmentLayer.json +43 -1
- package/lib/schema/project/layers/vectorTileLayer.json +38 -0
- package/package.json +1 -1
|
@@ -304,7 +304,6 @@
|
|
|
304
304
|
},
|
|
305
305
|
"StorySegmentLayer": {
|
|
306
306
|
"type": "object",
|
|
307
|
-
"additionalProperties": false,
|
|
308
307
|
"required": [
|
|
309
308
|
"zoom",
|
|
310
309
|
"extent",
|
|
@@ -324,9 +323,11 @@
|
|
|
324
323
|
},
|
|
325
324
|
"content": {
|
|
326
325
|
"type": "object",
|
|
326
|
+
"title": "Segment Content",
|
|
327
327
|
"additionalProperties": false,
|
|
328
328
|
"properties": {
|
|
329
329
|
"title": {
|
|
330
|
+
"title": "Segment Title",
|
|
330
331
|
"type": "string"
|
|
331
332
|
},
|
|
332
333
|
"image": {
|
|
@@ -363,6 +364,47 @@
|
|
|
363
364
|
"type",
|
|
364
365
|
"time"
|
|
365
366
|
]
|
|
367
|
+
},
|
|
368
|
+
"layerOverride": {
|
|
369
|
+
"type": "array",
|
|
370
|
+
"title": "Symbology Override",
|
|
371
|
+
"description": "Symbology overrides to apply to target layers when this story segment is active",
|
|
372
|
+
"items": {
|
|
373
|
+
"type": "object",
|
|
374
|
+
"properties": {
|
|
375
|
+
"targetLayer": {
|
|
376
|
+
"type": "string",
|
|
377
|
+
"title": "Target Layer",
|
|
378
|
+
"description": "The name of the layer to apply a symbology override to when this story segment is active",
|
|
379
|
+
"default": ""
|
|
380
|
+
},
|
|
381
|
+
"visible": {
|
|
382
|
+
"type": "boolean",
|
|
383
|
+
"title": "Visibility",
|
|
384
|
+
"default": true,
|
|
385
|
+
"description": "Override the target layer visibility while this story segment is active"
|
|
386
|
+
},
|
|
387
|
+
"opacity": {
|
|
388
|
+
"type": "number",
|
|
389
|
+
"title": "Opacity",
|
|
390
|
+
"description": "Override the target layer opacity while this story segment is active",
|
|
391
|
+
"minimum": 0,
|
|
392
|
+
"maximum": 1,
|
|
393
|
+
"multipleOf": 0.1,
|
|
394
|
+
"default": 1
|
|
395
|
+
},
|
|
396
|
+
"symbologyState": {
|
|
397
|
+
"type": "object",
|
|
398
|
+
"description": "The symbology state override (renderType, value, method, etc.)",
|
|
399
|
+
"default": {}
|
|
400
|
+
},
|
|
401
|
+
"color": {
|
|
402
|
+
"type": "object",
|
|
403
|
+
"description": "The color/style override",
|
|
404
|
+
"default": {}
|
|
405
|
+
}
|
|
406
|
+
}
|
|
407
|
+
}
|
|
366
408
|
}
|
|
367
409
|
}
|
|
368
410
|
},
|
|
@@ -460,6 +502,53 @@
|
|
|
460
502
|
"multipleOf": 0.1,
|
|
461
503
|
"minimum": 0,
|
|
462
504
|
"maximum": 1
|
|
505
|
+
},
|
|
506
|
+
"symbologyState": {
|
|
507
|
+
"type": "object",
|
|
508
|
+
"description": "The state of the symbology panel options",
|
|
509
|
+
"required": [
|
|
510
|
+
"renderType"
|
|
511
|
+
],
|
|
512
|
+
"properties": {
|
|
513
|
+
"renderType": {
|
|
514
|
+
"type": "string",
|
|
515
|
+
"enum": [
|
|
516
|
+
"Single Symbol",
|
|
517
|
+
"Graduated",
|
|
518
|
+
"Categorized"
|
|
519
|
+
]
|
|
520
|
+
},
|
|
521
|
+
"value": {
|
|
522
|
+
"type": "string"
|
|
523
|
+
},
|
|
524
|
+
"method": {
|
|
525
|
+
"type": "string",
|
|
526
|
+
"enum": [
|
|
527
|
+
"color",
|
|
528
|
+
"radius"
|
|
529
|
+
]
|
|
530
|
+
},
|
|
531
|
+
"colorRamp": {
|
|
532
|
+
"type": "string",
|
|
533
|
+
"default": "viridis"
|
|
534
|
+
},
|
|
535
|
+
"nClasses": {
|
|
536
|
+
"type": "string",
|
|
537
|
+
"default": "9"
|
|
538
|
+
},
|
|
539
|
+
"mode": {
|
|
540
|
+
"type": "string",
|
|
541
|
+
"default": "equal interval",
|
|
542
|
+
"enum": [
|
|
543
|
+
"quantile",
|
|
544
|
+
"equal interval",
|
|
545
|
+
"jenks",
|
|
546
|
+
"pretty",
|
|
547
|
+
"logarithmic"
|
|
548
|
+
]
|
|
549
|
+
}
|
|
550
|
+
},
|
|
551
|
+
"additionalProperties": false
|
|
463
552
|
}
|
|
464
553
|
}
|
|
465
554
|
},
|
|
@@ -5,23 +5,48 @@
|
|
|
5
5
|
* and run json-schema-to-typescript to regenerate this file.
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
|
+
export type SegmentTitle = string;
|
|
9
|
+
/**
|
|
10
|
+
* The name of the layer to apply a symbology override to when this story segment is active
|
|
11
|
+
*/
|
|
12
|
+
export type TargetLayer = string;
|
|
13
|
+
/**
|
|
14
|
+
* Override the target layer visibility while this story segment is active
|
|
15
|
+
*/
|
|
16
|
+
export type Visibility = boolean;
|
|
17
|
+
/**
|
|
18
|
+
* Override the target layer opacity while this story segment is active
|
|
19
|
+
*/
|
|
20
|
+
export type Opacity = number;
|
|
21
|
+
/**
|
|
22
|
+
* Symbology overrides to apply to target layers when this story segment is active
|
|
23
|
+
*/
|
|
24
|
+
export type SymbologyOverride = {
|
|
25
|
+
targetLayer?: TargetLayer;
|
|
26
|
+
visible?: Visibility;
|
|
27
|
+
opacity?: Opacity;
|
|
28
|
+
/**
|
|
29
|
+
* The symbology state override (renderType, value, method, etc.)
|
|
30
|
+
*/
|
|
31
|
+
symbologyState?: {
|
|
32
|
+
[k: string]: any;
|
|
33
|
+
};
|
|
34
|
+
/**
|
|
35
|
+
* The color/style override
|
|
36
|
+
*/
|
|
37
|
+
color?: {
|
|
38
|
+
[k: string]: any;
|
|
39
|
+
};
|
|
40
|
+
[k: string]: any;
|
|
41
|
+
}[];
|
|
42
|
+
|
|
8
43
|
/**
|
|
9
44
|
* StorySegmentLayer
|
|
10
45
|
*/
|
|
11
46
|
export interface IStorySegmentLayer {
|
|
12
47
|
zoom: number;
|
|
13
48
|
extent: number[];
|
|
14
|
-
content?:
|
|
15
|
-
title?: string;
|
|
16
|
-
/**
|
|
17
|
-
* Link to image for the story
|
|
18
|
-
*/
|
|
19
|
-
image?: string;
|
|
20
|
-
/**
|
|
21
|
-
* Markdown string representing the content of the story stop
|
|
22
|
-
*/
|
|
23
|
-
markdown?: string;
|
|
24
|
-
};
|
|
49
|
+
content?: SegmentContent;
|
|
25
50
|
/**
|
|
26
51
|
* Transition configuration between to this story segment
|
|
27
52
|
*/
|
|
@@ -36,4 +61,17 @@ export interface IStorySegmentLayer {
|
|
|
36
61
|
time: number;
|
|
37
62
|
[k: string]: any;
|
|
38
63
|
};
|
|
64
|
+
layerOverride?: SymbologyOverride;
|
|
65
|
+
[k: string]: any;
|
|
66
|
+
}
|
|
67
|
+
export interface SegmentContent {
|
|
68
|
+
title?: SegmentTitle;
|
|
69
|
+
/**
|
|
70
|
+
* Link to image for the story
|
|
71
|
+
*/
|
|
72
|
+
image?: string;
|
|
73
|
+
/**
|
|
74
|
+
* Markdown string representing the content of the story stop
|
|
75
|
+
*/
|
|
76
|
+
markdown?: string;
|
|
39
77
|
}
|
|
@@ -23,4 +23,15 @@ export interface IVectorTileLayer {
|
|
|
23
23
|
* The opacity of the the object
|
|
24
24
|
*/
|
|
25
25
|
opacity?: number;
|
|
26
|
+
/**
|
|
27
|
+
* The state of the symbology panel options
|
|
28
|
+
*/
|
|
29
|
+
symbologyState?: {
|
|
30
|
+
renderType: "Single Symbol" | "Graduated" | "Categorized";
|
|
31
|
+
value?: string;
|
|
32
|
+
method?: "color" | "radius";
|
|
33
|
+
colorRamp?: string;
|
|
34
|
+
nClasses?: string;
|
|
35
|
+
mode?: "quantile" | "equal interval" | "jenks" | "pretty" | "logarithmic";
|
|
36
|
+
};
|
|
26
37
|
}
|
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
"type": "object",
|
|
3
3
|
"description": "StorySegmentLayer",
|
|
4
4
|
"title": "IStorySegmentLayer",
|
|
5
|
-
"additionalProperties": false,
|
|
6
5
|
"required": ["zoom", "extent", "transition"],
|
|
7
6
|
"properties": {
|
|
8
7
|
"zoom": {
|
|
@@ -18,9 +17,11 @@
|
|
|
18
17
|
},
|
|
19
18
|
"content": {
|
|
20
19
|
"type": "object",
|
|
20
|
+
"title": "Segment Content",
|
|
21
21
|
"additionalProperties": false,
|
|
22
22
|
"properties": {
|
|
23
23
|
"title": {
|
|
24
|
+
"title": "Segment Title",
|
|
24
25
|
"type": "string"
|
|
25
26
|
},
|
|
26
27
|
"image": {
|
|
@@ -50,6 +51,47 @@
|
|
|
50
51
|
}
|
|
51
52
|
},
|
|
52
53
|
"required": ["type", "time"]
|
|
54
|
+
},
|
|
55
|
+
"layerOverride": {
|
|
56
|
+
"type": "array",
|
|
57
|
+
"title": "Symbology Override",
|
|
58
|
+
"description": "Symbology overrides to apply to target layers when this story segment is active",
|
|
59
|
+
"items": {
|
|
60
|
+
"type": "object",
|
|
61
|
+
"properties": {
|
|
62
|
+
"targetLayer": {
|
|
63
|
+
"type": "string",
|
|
64
|
+
"title": "Target Layer",
|
|
65
|
+
"description": "The name of the layer to apply a symbology override to when this story segment is active",
|
|
66
|
+
"default": ""
|
|
67
|
+
},
|
|
68
|
+
"visible": {
|
|
69
|
+
"type": "boolean",
|
|
70
|
+
"title": "Visibility",
|
|
71
|
+
"default": true,
|
|
72
|
+
"description": "Override the target layer visibility while this story segment is active"
|
|
73
|
+
},
|
|
74
|
+
"opacity": {
|
|
75
|
+
"type": "number",
|
|
76
|
+
"title": "Opacity",
|
|
77
|
+
"description": "Override the target layer opacity while this story segment is active",
|
|
78
|
+
"minimum": 0,
|
|
79
|
+
"maximum": 1,
|
|
80
|
+
"multipleOf": 0.1,
|
|
81
|
+
"default": 1.0
|
|
82
|
+
},
|
|
83
|
+
"symbologyState": {
|
|
84
|
+
"type": "object",
|
|
85
|
+
"description": "The symbology state override (renderType, value, method, etc.)",
|
|
86
|
+
"default": {}
|
|
87
|
+
},
|
|
88
|
+
"color": {
|
|
89
|
+
"type": "object",
|
|
90
|
+
"description": "The color/style override",
|
|
91
|
+
"default": {}
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
}
|
|
53
95
|
}
|
|
54
96
|
}
|
|
55
97
|
}
|
|
@@ -20,6 +20,44 @@
|
|
|
20
20
|
"multipleOf": 0.1,
|
|
21
21
|
"minimum": 0,
|
|
22
22
|
"maximum": 1
|
|
23
|
+
},
|
|
24
|
+
"symbologyState": {
|
|
25
|
+
"type": "object",
|
|
26
|
+
"description": "The state of the symbology panel options",
|
|
27
|
+
"required": ["renderType"],
|
|
28
|
+
"properties": {
|
|
29
|
+
"renderType": {
|
|
30
|
+
"type": "string",
|
|
31
|
+
"enum": ["Single Symbol", "Graduated", "Categorized"]
|
|
32
|
+
},
|
|
33
|
+
"value": {
|
|
34
|
+
"type": "string"
|
|
35
|
+
},
|
|
36
|
+
"method": {
|
|
37
|
+
"type": "string",
|
|
38
|
+
"enum": ["color", "radius"]
|
|
39
|
+
},
|
|
40
|
+
"colorRamp": {
|
|
41
|
+
"type": "string",
|
|
42
|
+
"default": "viridis"
|
|
43
|
+
},
|
|
44
|
+
"nClasses": {
|
|
45
|
+
"type": "string",
|
|
46
|
+
"default": "9"
|
|
47
|
+
},
|
|
48
|
+
"mode": {
|
|
49
|
+
"type": "string",
|
|
50
|
+
"default": "equal interval",
|
|
51
|
+
"enum": [
|
|
52
|
+
"quantile",
|
|
53
|
+
"equal interval",
|
|
54
|
+
"jenks",
|
|
55
|
+
"pretty",
|
|
56
|
+
"logarithmic"
|
|
57
|
+
]
|
|
58
|
+
}
|
|
59
|
+
},
|
|
60
|
+
"additionalProperties": false
|
|
23
61
|
}
|
|
24
62
|
}
|
|
25
63
|
}
|