@genome-spy/core 0.50.0 → 0.50.2
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/dist/bundle/index.es.js +3560 -3524
- package/dist/bundle/index.js +86 -86
- package/dist/schema.json +339 -256
- package/dist/src/data/flowOptimizer.d.ts.map +1 -1
- package/dist/src/data/flowOptimizer.js +1 -2
- package/dist/src/data/sources/lazy/axisTickSource.d.ts.map +1 -1
- package/dist/src/data/sources/lazy/axisTickSource.js +8 -1
- package/dist/src/data/sources/urlSource.d.ts.map +1 -1
- package/dist/src/data/sources/urlSource.js +17 -13
- package/dist/src/genomeSpy.d.ts.map +1 -1
- package/dist/src/genomeSpy.js +12 -8
- package/dist/src/index.d.ts +1 -1
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +5 -2
- package/dist/src/marks/mark.d.ts +1 -0
- package/dist/src/marks/mark.d.ts.map +1 -1
- package/dist/src/marks/mark.js +7 -4
- package/dist/src/spec/mark.d.ts +43 -9
- package/dist/src/spec/view.d.ts +113 -32
- package/dist/src/styles/genome-spy.css.d.ts +1 -1
- package/dist/src/styles/genome-spy.css.d.ts.map +1 -1
- package/dist/src/styles/genome-spy.css.js +1 -0
- package/dist/src/styles/genome-spy.scss +1 -0
- package/dist/src/utils/url.d.ts +9 -2
- package/dist/src/utils/url.d.ts.map +1 -1
- package/dist/src/utils/url.js +29 -6
- package/dist/src/utils/url.test.d.ts +2 -0
- package/dist/src/utils/url.test.d.ts.map +1 -0
- package/dist/src/utils/url.test.js +28 -0
- package/dist/src/view/axisResolution.d.ts.map +1 -1
- package/dist/src/view/axisResolution.js +7 -1
- package/dist/src/view/layout/flexLayout.d.ts +6 -0
- package/dist/src/view/layout/flexLayout.d.ts.map +1 -1
- package/dist/src/view/layout/flexLayout.js +9 -0
- package/dist/src/view/view.d.ts.map +1 -1
- package/dist/src/view/view.js +3 -3
- package/dist/src/view/viewUtils.d.ts +2 -6
- package/dist/src/view/viewUtils.d.ts.map +1 -1
- package/dist/src/view/viewUtils.js +41 -33
- package/package.json +2 -2
package/dist/schema.json
CHANGED
|
@@ -853,7 +853,7 @@
|
|
|
853
853
|
"additionalProperties": false,
|
|
854
854
|
"properties": {
|
|
855
855
|
"baseUrl": {
|
|
856
|
-
"description": "
|
|
856
|
+
"description": "The base URL for relative URL data sources and URL [imports](https://genomespy.app/docs/grammar/import/#importing-from-a-url). The base URLs are inherited in the view hierarchy unless overridden with this property. By default, the top-level view's base URL equals to the visualization specification's base URL.",
|
|
857
857
|
"type": "string"
|
|
858
858
|
},
|
|
859
859
|
"columns": {
|
|
@@ -875,11 +875,12 @@
|
|
|
875
875
|
"type": "array"
|
|
876
876
|
},
|
|
877
877
|
"configurableVisibility": {
|
|
878
|
-
"description": "Is the visibility configurable interactively from the App. Configurability requires that the view has an explicitly specified name that is *unique* in within the view
|
|
878
|
+
"description": "Is the visibility configurable interactively from the [GenomeSpy App](https://genomespy.app/docs/sample-collections/). Configurability requires that the view has an explicitly specified name that is *unique* in within the view hierarchy.\n\n**Default:** `false` for children of `layer`, `true` for others.",
|
|
879
879
|
"type": "boolean"
|
|
880
880
|
},
|
|
881
881
|
"data": {
|
|
882
|
-
"$ref": "#/definitions/Data"
|
|
882
|
+
"$ref": "#/definitions/Data",
|
|
883
|
+
"description": "Specifies a [data source](https://genomespy.app/docs/grammar/data/). If omitted, the data source is inherited from the parent view."
|
|
883
884
|
},
|
|
884
885
|
"description": {
|
|
885
886
|
"anyOf": [
|
|
@@ -893,10 +894,11 @@
|
|
|
893
894
|
"type": "array"
|
|
894
895
|
}
|
|
895
896
|
],
|
|
896
|
-
"description": "A description of the view.
|
|
897
|
+
"description": "A description of the view. Can be used for documentation. The description of the top-level view is shown in the toolbar of the [GenomeSpy App](https://genomespy.app/docs/sample-collections/)."
|
|
897
898
|
},
|
|
898
899
|
"encoding": {
|
|
899
|
-
"$ref": "#/definitions/Encoding"
|
|
900
|
+
"$ref": "#/definitions/Encoding",
|
|
901
|
+
"description": "Specifies how data are [encoded](https://genomespy.app/docs/grammar/mark/#encoding) using the visual channels."
|
|
900
902
|
},
|
|
901
903
|
"height": {
|
|
902
904
|
"anyOf": [
|
|
@@ -914,21 +916,18 @@
|
|
|
914
916
|
"type": "string"
|
|
915
917
|
}
|
|
916
918
|
],
|
|
917
|
-
"description": "Height of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
919
|
+
"description": "Height of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default value:** `\"container\"`"
|
|
918
920
|
},
|
|
919
921
|
"name": {
|
|
922
|
+
"description": "An internal name that can be used for referring the view. For referencing purposes, the name should be unique within the view hierarchy.",
|
|
920
923
|
"type": "string"
|
|
921
924
|
},
|
|
922
|
-
"opacity": {
|
|
923
|
-
"$ref": "#/definitions/ViewOpacityDef",
|
|
924
|
-
"description": "Opacity of the view and all its children.\n\n**Default:** `1.0`"
|
|
925
|
-
},
|
|
926
925
|
"padding": {
|
|
927
926
|
"$ref": "#/definitions/PaddingConfig",
|
|
928
|
-
"description": "Padding
|
|
927
|
+
"description": "Padding applied to the view. Accepts either a number representing pixels or an object specifying separate paddings for each edge.\n\nExamples:\n- `padding: 10`\n- `padding: { top: 10, right: 20, bottom: 10, left: 20 }`\n\n**Default value:** `0`"
|
|
929
928
|
},
|
|
930
929
|
"params": {
|
|
931
|
-
"description": "Dynamic variables that parameterize a visualization.",
|
|
930
|
+
"description": "Dynamic variables that [parameterize](https://genomespy.app/docs/grammar/parameters/) a visualization.",
|
|
932
931
|
"items": {
|
|
933
932
|
"$ref": "#/definitions/Parameter"
|
|
934
933
|
},
|
|
@@ -936,6 +935,7 @@
|
|
|
936
935
|
},
|
|
937
936
|
"resolve": {
|
|
938
937
|
"additionalProperties": false,
|
|
938
|
+
"description": "Specifies how scales and axes are [resolved](https://genomespy.app/docs/grammar/composition/#scale-and-axis-resolution) in the view hierarchy.",
|
|
939
939
|
"properties": {
|
|
940
940
|
"axis": {
|
|
941
941
|
"additionalProperties": {
|
|
@@ -970,7 +970,7 @@
|
|
|
970
970
|
"additionalProperties": {
|
|
971
971
|
"$ref": "#/definitions/ViewSpec"
|
|
972
972
|
},
|
|
973
|
-
"description": "Templates that can be reused within the view specification by importing them with the template key.",
|
|
973
|
+
"description": "[Templates](https://genomespy.app/docs/grammar/import/#repeating-with-named-templates) that can be reused within the view specification by importing them with the template key.",
|
|
974
974
|
"type": "object"
|
|
975
975
|
},
|
|
976
976
|
"title": {
|
|
@@ -981,9 +981,11 @@
|
|
|
981
981
|
{
|
|
982
982
|
"$ref": "#/definitions/Title"
|
|
983
983
|
}
|
|
984
|
-
]
|
|
984
|
+
],
|
|
985
|
+
"description": "View title. N.B.: Currently, GenomeSpy doesn't do bound calculation, and you need to manually specify proper padding for the view to ensure that the title is visible."
|
|
985
986
|
},
|
|
986
987
|
"transform": {
|
|
988
|
+
"description": "An array of [transformations](https://genomespy.app/docs/grammar/transform/) applied to the data before visual encoding.",
|
|
987
989
|
"items": {
|
|
988
990
|
"$ref": "#/definitions/TransformParams"
|
|
989
991
|
},
|
|
@@ -1002,7 +1004,7 @@
|
|
|
1002
1004
|
"type": "string"
|
|
1003
1005
|
}
|
|
1004
1006
|
],
|
|
1005
|
-
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
1007
|
+
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
1006
1008
|
},
|
|
1007
1009
|
"viewportWidth": {
|
|
1008
1010
|
"anyOf": [
|
|
@@ -1017,10 +1019,10 @@
|
|
|
1017
1019
|
"type": "string"
|
|
1018
1020
|
}
|
|
1019
1021
|
],
|
|
1020
|
-
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
1022
|
+
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
1021
1023
|
},
|
|
1022
1024
|
"visible": {
|
|
1023
|
-
"description": "
|
|
1025
|
+
"description": "The default visibility of the view. An invisible view is removed from the layout and not rendered. For context, see [toggleable view visibility](https://genomespy.app/docs/sample-collections/visualizing/#toggleable-view-visibility).\n\n**Default:** `true`",
|
|
1024
1026
|
"type": "boolean"
|
|
1025
1027
|
},
|
|
1026
1028
|
"width": {
|
|
@@ -1039,7 +1041,7 @@
|
|
|
1039
1041
|
"type": "string"
|
|
1040
1042
|
}
|
|
1041
1043
|
],
|
|
1042
|
-
"description": "Width of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
1044
|
+
"description": "Width of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default:** `\"container\"`"
|
|
1043
1045
|
}
|
|
1044
1046
|
},
|
|
1045
1047
|
"required": [
|
|
@@ -2917,15 +2919,16 @@
|
|
|
2917
2919
|
"additionalProperties": false,
|
|
2918
2920
|
"properties": {
|
|
2919
2921
|
"baseUrl": {
|
|
2920
|
-
"description": "
|
|
2922
|
+
"description": "The base URL for relative URL data sources and URL [imports](https://genomespy.app/docs/grammar/import/#importing-from-a-url). The base URLs are inherited in the view hierarchy unless overridden with this property. By default, the top-level view's base URL equals to the visualization specification's base URL.",
|
|
2921
2923
|
"type": "string"
|
|
2922
2924
|
},
|
|
2923
2925
|
"configurableVisibility": {
|
|
2924
|
-
"description": "Is the visibility configurable interactively from the App. Configurability requires that the view has an explicitly specified name that is *unique* in within the view
|
|
2926
|
+
"description": "Is the visibility configurable interactively from the [GenomeSpy App](https://genomespy.app/docs/sample-collections/). Configurability requires that the view has an explicitly specified name that is *unique* in within the view hierarchy.\n\n**Default:** `false` for children of `layer`, `true` for others.",
|
|
2925
2927
|
"type": "boolean"
|
|
2926
2928
|
},
|
|
2927
2929
|
"data": {
|
|
2928
|
-
"$ref": "#/definitions/Data"
|
|
2930
|
+
"$ref": "#/definitions/Data",
|
|
2931
|
+
"description": "Specifies a [data source](https://genomespy.app/docs/grammar/data/). If omitted, the data source is inherited from the parent view."
|
|
2929
2932
|
},
|
|
2930
2933
|
"description": {
|
|
2931
2934
|
"anyOf": [
|
|
@@ -2939,10 +2942,11 @@
|
|
|
2939
2942
|
"type": "array"
|
|
2940
2943
|
}
|
|
2941
2944
|
],
|
|
2942
|
-
"description": "A description of the view.
|
|
2945
|
+
"description": "A description of the view. Can be used for documentation. The description of the top-level view is shown in the toolbar of the [GenomeSpy App](https://genomespy.app/docs/sample-collections/)."
|
|
2943
2946
|
},
|
|
2944
2947
|
"encoding": {
|
|
2945
|
-
"$ref": "#/definitions/Encoding"
|
|
2948
|
+
"$ref": "#/definitions/Encoding",
|
|
2949
|
+
"description": "Specifies how data are [encoded](https://genomespy.app/docs/grammar/mark/#encoding) using the visual channels."
|
|
2946
2950
|
},
|
|
2947
2951
|
"hconcat": {
|
|
2948
2952
|
"description": "Specifies views that will be concatenated horizontally.",
|
|
@@ -2974,21 +2978,18 @@
|
|
|
2974
2978
|
"type": "string"
|
|
2975
2979
|
}
|
|
2976
2980
|
],
|
|
2977
|
-
"description": "Height of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
2981
|
+
"description": "Height of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default value:** `\"container\"`"
|
|
2978
2982
|
},
|
|
2979
2983
|
"name": {
|
|
2984
|
+
"description": "An internal name that can be used for referring the view. For referencing purposes, the name should be unique within the view hierarchy.",
|
|
2980
2985
|
"type": "string"
|
|
2981
2986
|
},
|
|
2982
|
-
"opacity": {
|
|
2983
|
-
"$ref": "#/definitions/ViewOpacityDef",
|
|
2984
|
-
"description": "Opacity of the view and all its children.\n\n**Default:** `1.0`"
|
|
2985
|
-
},
|
|
2986
2987
|
"padding": {
|
|
2987
2988
|
"$ref": "#/definitions/PaddingConfig",
|
|
2988
|
-
"description": "Padding
|
|
2989
|
+
"description": "Padding applied to the view. Accepts either a number representing pixels or an object specifying separate paddings for each edge.\n\nExamples:\n- `padding: 10`\n- `padding: { top: 10, right: 20, bottom: 10, left: 20 }`\n\n**Default value:** `0`"
|
|
2989
2990
|
},
|
|
2990
2991
|
"params": {
|
|
2991
|
-
"description": "Dynamic variables that parameterize a visualization.",
|
|
2992
|
+
"description": "Dynamic variables that [parameterize](https://genomespy.app/docs/grammar/parameters/) a visualization.",
|
|
2992
2993
|
"items": {
|
|
2993
2994
|
"$ref": "#/definitions/Parameter"
|
|
2994
2995
|
},
|
|
@@ -2996,6 +2997,7 @@
|
|
|
2996
2997
|
},
|
|
2997
2998
|
"resolve": {
|
|
2998
2999
|
"additionalProperties": false,
|
|
3000
|
+
"description": "Specifies how scales and axes are [resolved](https://genomespy.app/docs/grammar/composition/#scale-and-axis-resolution) in the view hierarchy.",
|
|
2999
3001
|
"properties": {
|
|
3000
3002
|
"axis": {
|
|
3001
3003
|
"additionalProperties": {
|
|
@@ -3030,7 +3032,7 @@
|
|
|
3030
3032
|
"additionalProperties": {
|
|
3031
3033
|
"$ref": "#/definitions/ViewSpec"
|
|
3032
3034
|
},
|
|
3033
|
-
"description": "Templates that can be reused within the view specification by importing them with the template key.",
|
|
3035
|
+
"description": "[Templates](https://genomespy.app/docs/grammar/import/#repeating-with-named-templates) that can be reused within the view specification by importing them with the template key.",
|
|
3034
3036
|
"type": "object"
|
|
3035
3037
|
},
|
|
3036
3038
|
"title": {
|
|
@@ -3041,9 +3043,11 @@
|
|
|
3041
3043
|
{
|
|
3042
3044
|
"$ref": "#/definitions/Title"
|
|
3043
3045
|
}
|
|
3044
|
-
]
|
|
3046
|
+
],
|
|
3047
|
+
"description": "View title. N.B.: Currently, GenomeSpy doesn't do bound calculation, and you need to manually specify proper padding for the view to ensure that the title is visible."
|
|
3045
3048
|
},
|
|
3046
3049
|
"transform": {
|
|
3050
|
+
"description": "An array of [transformations](https://genomespy.app/docs/grammar/transform/) applied to the data before visual encoding.",
|
|
3047
3051
|
"items": {
|
|
3048
3052
|
"$ref": "#/definitions/TransformParams"
|
|
3049
3053
|
},
|
|
@@ -3062,7 +3066,7 @@
|
|
|
3062
3066
|
"type": "string"
|
|
3063
3067
|
}
|
|
3064
3068
|
],
|
|
3065
|
-
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
3069
|
+
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
3066
3070
|
},
|
|
3067
3071
|
"viewportWidth": {
|
|
3068
3072
|
"anyOf": [
|
|
@@ -3077,10 +3081,10 @@
|
|
|
3077
3081
|
"type": "string"
|
|
3078
3082
|
}
|
|
3079
3083
|
],
|
|
3080
|
-
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
3084
|
+
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
3081
3085
|
},
|
|
3082
3086
|
"visible": {
|
|
3083
|
-
"description": "
|
|
3087
|
+
"description": "The default visibility of the view. An invisible view is removed from the layout and not rendered. For context, see [toggleable view visibility](https://genomespy.app/docs/sample-collections/visualizing/#toggleable-view-visibility).\n\n**Default:** `true`",
|
|
3084
3088
|
"type": "boolean"
|
|
3085
3089
|
},
|
|
3086
3090
|
"width": {
|
|
@@ -3099,7 +3103,7 @@
|
|
|
3099
3103
|
"type": "string"
|
|
3100
3104
|
}
|
|
3101
3105
|
],
|
|
3102
|
-
"description": "Width of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
3106
|
+
"description": "Width of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default:** `\"container\"`"
|
|
3103
3107
|
}
|
|
3104
3108
|
},
|
|
3105
3109
|
"required": [
|
|
@@ -3348,6 +3352,7 @@
|
|
|
3348
3352
|
"additionalProperties": false,
|
|
3349
3353
|
"properties": {
|
|
3350
3354
|
"aggregateSamples": {
|
|
3355
|
+
"description": "Specifies views that [aggregate](https://genomespy.app/docs/sample-collections/visualizing/#aggregation) multiple samples within the GenomeSpy App.",
|
|
3351
3356
|
"items": {
|
|
3352
3357
|
"anyOf": [
|
|
3353
3358
|
{
|
|
@@ -3361,15 +3366,16 @@
|
|
|
3361
3366
|
"type": "array"
|
|
3362
3367
|
},
|
|
3363
3368
|
"baseUrl": {
|
|
3364
|
-
"description": "
|
|
3369
|
+
"description": "The base URL for relative URL data sources and URL [imports](https://genomespy.app/docs/grammar/import/#importing-from-a-url). The base URLs are inherited in the view hierarchy unless overridden with this property. By default, the top-level view's base URL equals to the visualization specification's base URL.",
|
|
3365
3370
|
"type": "string"
|
|
3366
3371
|
},
|
|
3367
3372
|
"configurableVisibility": {
|
|
3368
|
-
"description": "Is the visibility configurable interactively from the App. Configurability requires that the view has an explicitly specified name that is *unique* in within the view
|
|
3373
|
+
"description": "Is the visibility configurable interactively from the [GenomeSpy App](https://genomespy.app/docs/sample-collections/). Configurability requires that the view has an explicitly specified name that is *unique* in within the view hierarchy.\n\n**Default:** `false` for children of `layer`, `true` for others.",
|
|
3369
3374
|
"type": "boolean"
|
|
3370
3375
|
},
|
|
3371
3376
|
"data": {
|
|
3372
|
-
"$ref": "#/definitions/Data"
|
|
3377
|
+
"$ref": "#/definitions/Data",
|
|
3378
|
+
"description": "Specifies a [data source](https://genomespy.app/docs/grammar/data/). If omitted, the data source is inherited from the parent view."
|
|
3373
3379
|
},
|
|
3374
3380
|
"description": {
|
|
3375
3381
|
"anyOf": [
|
|
@@ -3383,10 +3389,11 @@
|
|
|
3383
3389
|
"type": "array"
|
|
3384
3390
|
}
|
|
3385
3391
|
],
|
|
3386
|
-
"description": "A description of the view.
|
|
3392
|
+
"description": "A description of the view. Can be used for documentation. The description of the top-level view is shown in the toolbar of the [GenomeSpy App](https://genomespy.app/docs/sample-collections/)."
|
|
3387
3393
|
},
|
|
3388
3394
|
"encoding": {
|
|
3389
|
-
"$ref": "#/definitions/Encoding"
|
|
3395
|
+
"$ref": "#/definitions/Encoding",
|
|
3396
|
+
"description": "Specifies how data are [encoded](https://genomespy.app/docs/grammar/mark/#encoding) using the visual channels."
|
|
3390
3397
|
},
|
|
3391
3398
|
"height": {
|
|
3392
3399
|
"anyOf": [
|
|
@@ -3404,7 +3411,7 @@
|
|
|
3404
3411
|
"type": "string"
|
|
3405
3412
|
}
|
|
3406
3413
|
],
|
|
3407
|
-
"description": "Height of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
3414
|
+
"description": "Height of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default value:** `\"container\"`"
|
|
3408
3415
|
},
|
|
3409
3416
|
"layer": {
|
|
3410
3417
|
"items": {
|
|
@@ -3423,18 +3430,19 @@
|
|
|
3423
3430
|
"type": "array"
|
|
3424
3431
|
},
|
|
3425
3432
|
"name": {
|
|
3433
|
+
"description": "An internal name that can be used for referring the view. For referencing purposes, the name should be unique within the view hierarchy.",
|
|
3426
3434
|
"type": "string"
|
|
3427
3435
|
},
|
|
3428
3436
|
"opacity": {
|
|
3429
3437
|
"$ref": "#/definitions/ViewOpacityDef",
|
|
3430
|
-
"description": "Opacity of the view and all its children.\n\n**Default:** `1.0`"
|
|
3438
|
+
"description": "Opacity of the view and all its children. Allows implementing semantic zooming where the layers are faded in and out as the user zooms in and out.\n\nTODO: Write proper documentation with examples.\n\n**Default:** `1.0`"
|
|
3431
3439
|
},
|
|
3432
3440
|
"padding": {
|
|
3433
3441
|
"$ref": "#/definitions/PaddingConfig",
|
|
3434
|
-
"description": "Padding
|
|
3442
|
+
"description": "Padding applied to the view. Accepts either a number representing pixels or an object specifying separate paddings for each edge.\n\nExamples:\n- `padding: 10`\n- `padding: { top: 10, right: 20, bottom: 10, left: 20 }`\n\n**Default value:** `0`"
|
|
3435
3443
|
},
|
|
3436
3444
|
"params": {
|
|
3437
|
-
"description": "Dynamic variables that parameterize a visualization.",
|
|
3445
|
+
"description": "Dynamic variables that [parameterize](https://genomespy.app/docs/grammar/parameters/) a visualization.",
|
|
3438
3446
|
"items": {
|
|
3439
3447
|
"$ref": "#/definitions/Parameter"
|
|
3440
3448
|
},
|
|
@@ -3442,6 +3450,7 @@
|
|
|
3442
3450
|
},
|
|
3443
3451
|
"resolve": {
|
|
3444
3452
|
"additionalProperties": false,
|
|
3453
|
+
"description": "Specifies how scales and axes are [resolved](https://genomespy.app/docs/grammar/composition/#scale-and-axis-resolution) in the view hierarchy.",
|
|
3445
3454
|
"properties": {
|
|
3446
3455
|
"axis": {
|
|
3447
3456
|
"additionalProperties": {
|
|
@@ -3472,7 +3481,7 @@
|
|
|
3472
3481
|
"additionalProperties": {
|
|
3473
3482
|
"$ref": "#/definitions/ViewSpec"
|
|
3474
3483
|
},
|
|
3475
|
-
"description": "Templates that can be reused within the view specification by importing them with the template key.",
|
|
3484
|
+
"description": "[Templates](https://genomespy.app/docs/grammar/import/#repeating-with-named-templates) that can be reused within the view specification by importing them with the template key.",
|
|
3476
3485
|
"type": "object"
|
|
3477
3486
|
},
|
|
3478
3487
|
"title": {
|
|
@@ -3483,9 +3492,11 @@
|
|
|
3483
3492
|
{
|
|
3484
3493
|
"$ref": "#/definitions/Title"
|
|
3485
3494
|
}
|
|
3486
|
-
]
|
|
3495
|
+
],
|
|
3496
|
+
"description": "View title. N.B.: Currently, GenomeSpy doesn't do bound calculation, and you need to manually specify proper padding for the view to ensure that the title is visible."
|
|
3487
3497
|
},
|
|
3488
3498
|
"transform": {
|
|
3499
|
+
"description": "An array of [transformations](https://genomespy.app/docs/grammar/transform/) applied to the data before visual encoding.",
|
|
3489
3500
|
"items": {
|
|
3490
3501
|
"$ref": "#/definitions/TransformParams"
|
|
3491
3502
|
},
|
|
@@ -3507,7 +3518,7 @@
|
|
|
3507
3518
|
"type": "string"
|
|
3508
3519
|
}
|
|
3509
3520
|
],
|
|
3510
|
-
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
3521
|
+
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
3511
3522
|
},
|
|
3512
3523
|
"viewportWidth": {
|
|
3513
3524
|
"anyOf": [
|
|
@@ -3522,10 +3533,10 @@
|
|
|
3522
3533
|
"type": "string"
|
|
3523
3534
|
}
|
|
3524
3535
|
],
|
|
3525
|
-
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
3536
|
+
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
3526
3537
|
},
|
|
3527
3538
|
"visible": {
|
|
3528
|
-
"description": "
|
|
3539
|
+
"description": "The default visibility of the view. An invisible view is removed from the layout and not rendered. For context, see [toggleable view visibility](https://genomespy.app/docs/sample-collections/visualizing/#toggleable-view-visibility).\n\n**Default:** `true`",
|
|
3529
3540
|
"type": "boolean"
|
|
3530
3541
|
},
|
|
3531
3542
|
"width": {
|
|
@@ -3544,7 +3555,7 @@
|
|
|
3544
3555
|
"type": "string"
|
|
3545
3556
|
}
|
|
3546
3557
|
],
|
|
3547
|
-
"description": "Width of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
3558
|
+
"description": "Width of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default:** `\"container\"`"
|
|
3548
3559
|
}
|
|
3549
3560
|
},
|
|
3550
3561
|
"required": [
|
|
@@ -3725,7 +3736,8 @@
|
|
|
3725
3736
|
{
|
|
3726
3737
|
"$ref": "#/definitions/ExprRef"
|
|
3727
3738
|
}
|
|
3728
|
-
]
|
|
3739
|
+
],
|
|
3740
|
+
"description": "Color of the mark. Affects either `fill` or `stroke`, depending on the `filled` property."
|
|
3729
3741
|
},
|
|
3730
3742
|
"linkShape": {
|
|
3731
3743
|
"anyOf": [
|
|
@@ -3749,7 +3761,7 @@
|
|
|
3749
3761
|
"$ref": "#/definitions/ExprRef"
|
|
3750
3762
|
}
|
|
3751
3763
|
],
|
|
3752
|
-
"description": "The shape of the link path.
|
|
3764
|
+
"description": "The shape of the link path.\n\nThe `\"arc\"` shape draws a circular arc between the two points. The apex of the arc resides on the left side of the line that connects the two points. The `\"dome\"` shape draws a vertical or horizontal arc with a specific height. The primary positional channel determines the apex of the arc and the secondary determines the endpoint placement. The `\"diagonal\"` shape draws an \"S\"-shaped curve between the two points. The `\"line\"` shape draws a straight line between the two points. See an [example](#different-link-shapes-and-orientations) of the different shapes below.\n\n**Default value:** `\"arc\"`"
|
|
3753
3765
|
},
|
|
3754
3766
|
"maxChordLength": {
|
|
3755
3767
|
"anyOf": [
|
|
@@ -3807,7 +3819,8 @@
|
|
|
3807
3819
|
{
|
|
3808
3820
|
"$ref": "#/definitions/ExprRef"
|
|
3809
3821
|
}
|
|
3810
|
-
]
|
|
3822
|
+
],
|
|
3823
|
+
"description": "Opacity of the mark. Affects `fillOpacity` or `strokeOpacity`, depending on the `filled` property."
|
|
3811
3824
|
},
|
|
3812
3825
|
"orient": {
|
|
3813
3826
|
"anyOf": [
|
|
@@ -3834,7 +3847,7 @@
|
|
|
3834
3847
|
"$ref": "#/definitions/ExprRef"
|
|
3835
3848
|
}
|
|
3836
3849
|
],
|
|
3837
|
-
"description": "The number of segments in the bézier curve. Affects the rendering quality and performance. Use a higher value for a smoother curve.\n\n**Default value
|
|
3850
|
+
"description": "The number of segments in the bézier curve. Affects the rendering quality and performance. Use a higher value for a smoother curve.\n\n**Default value:** `101`"
|
|
3838
3851
|
},
|
|
3839
3852
|
"size": {
|
|
3840
3853
|
"anyOf": [
|
|
@@ -3849,7 +3862,7 @@
|
|
|
3849
3862
|
},
|
|
3850
3863
|
"tooltip": {
|
|
3851
3864
|
"$ref": "#/definitions/Tooltip",
|
|
3852
|
-
"description": "Tooltip handler. If `null`, no tooltip is shown."
|
|
3865
|
+
"description": "Tooltip handler. If `null`, no tooltip is shown. If string, specifies the [tooltip handler](https://genomespy.app/docs/api/#custom-tooltip-handlers) to use."
|
|
3853
3866
|
},
|
|
3854
3867
|
"type": {
|
|
3855
3868
|
"const": "link",
|
|
@@ -3863,7 +3876,8 @@
|
|
|
3863
3876
|
{
|
|
3864
3877
|
"$ref": "#/definitions/ExprRef"
|
|
3865
3878
|
}
|
|
3866
|
-
]
|
|
3879
|
+
],
|
|
3880
|
+
"description": "Position on the x axis."
|
|
3867
3881
|
},
|
|
3868
3882
|
"x2": {
|
|
3869
3883
|
"anyOf": [
|
|
@@ -3873,7 +3887,8 @@
|
|
|
3873
3887
|
{
|
|
3874
3888
|
"$ref": "#/definitions/ExprRef"
|
|
3875
3889
|
}
|
|
3876
|
-
]
|
|
3890
|
+
],
|
|
3891
|
+
"description": "The secondary position on the x axis."
|
|
3877
3892
|
},
|
|
3878
3893
|
"xOffset": {
|
|
3879
3894
|
"description": "Offsets of the `x` and `x2` coordinates in pixels. The offset is applied after the viewport scaling and translation.\n\n**Default value:** `0`",
|
|
@@ -3887,7 +3902,8 @@
|
|
|
3887
3902
|
{
|
|
3888
3903
|
"$ref": "#/definitions/ExprRef"
|
|
3889
3904
|
}
|
|
3890
|
-
]
|
|
3905
|
+
],
|
|
3906
|
+
"description": "Position on the y axis."
|
|
3891
3907
|
},
|
|
3892
3908
|
"y2": {
|
|
3893
3909
|
"anyOf": [
|
|
@@ -3897,7 +3913,8 @@
|
|
|
3897
3913
|
{
|
|
3898
3914
|
"$ref": "#/definitions/ExprRef"
|
|
3899
3915
|
}
|
|
3900
|
-
]
|
|
3916
|
+
],
|
|
3917
|
+
"description": "The secondary position on the y axis."
|
|
3901
3918
|
},
|
|
3902
3919
|
"yOffset": {
|
|
3903
3920
|
"description": "Offsets of the `y` and `y2` coordinates in pixels. The offset is applied after the viewport scaling and translation.\n\n**Default value:** `0`",
|
|
@@ -4222,7 +4239,8 @@
|
|
|
4222
4239
|
{
|
|
4223
4240
|
"$ref": "#/definitions/ExprRef"
|
|
4224
4241
|
}
|
|
4225
|
-
]
|
|
4242
|
+
],
|
|
4243
|
+
"description": "Color of the mark. Affects either `fill` or `stroke`, depending on the `filled` property."
|
|
4226
4244
|
},
|
|
4227
4245
|
"fill": {
|
|
4228
4246
|
"anyOf": [
|
|
@@ -4233,7 +4251,7 @@
|
|
|
4233
4251
|
"$ref": "#/definitions/ExprRef"
|
|
4234
4252
|
}
|
|
4235
4253
|
],
|
|
4236
|
-
"description": "The fill color"
|
|
4254
|
+
"description": "The fill color."
|
|
4237
4255
|
},
|
|
4238
4256
|
"fillGradientStrength": {
|
|
4239
4257
|
"anyOf": [
|
|
@@ -4244,7 +4262,7 @@
|
|
|
4244
4262
|
"$ref": "#/definitions/ExprRef"
|
|
4245
4263
|
}
|
|
4246
4264
|
],
|
|
4247
|
-
"description": "Gradient strength controls the amount of the gradient eye-candy effect in the fill color. Valid values are between 0 and 1
|
|
4265
|
+
"description": "Gradient strength controls the amount of the gradient eye-candy effect in the fill color. Valid values are between `0` and `1`.\n\n**Default value:** `0`"
|
|
4248
4266
|
},
|
|
4249
4267
|
"fillOpacity": {
|
|
4250
4268
|
"anyOf": [
|
|
@@ -4255,7 +4273,7 @@
|
|
|
4255
4273
|
"$ref": "#/definitions/ExprRef"
|
|
4256
4274
|
}
|
|
4257
4275
|
],
|
|
4258
|
-
"description": "The fill opacity. Value between
|
|
4276
|
+
"description": "The fill opacity. Value between `0` and `1`."
|
|
4259
4277
|
},
|
|
4260
4278
|
"filled": {
|
|
4261
4279
|
"description": "Whether the `color` represents the `fill` color (`true`) or the `stroke` color (`false`).",
|
|
@@ -4299,7 +4317,8 @@
|
|
|
4299
4317
|
{
|
|
4300
4318
|
"$ref": "#/definitions/ExprRef"
|
|
4301
4319
|
}
|
|
4302
|
-
]
|
|
4320
|
+
],
|
|
4321
|
+
"description": "Opacity of the mark. Affects `fillOpacity` or `strokeOpacity`, depending on the `filled` property."
|
|
4303
4322
|
},
|
|
4304
4323
|
"semanticZoomFraction": {
|
|
4305
4324
|
"anyOf": [
|
|
@@ -4313,8 +4332,15 @@
|
|
|
4313
4332
|
"description": "TODO\n\n**Default value:** `0.02`"
|
|
4314
4333
|
},
|
|
4315
4334
|
"shape": {
|
|
4316
|
-
"
|
|
4317
|
-
|
|
4335
|
+
"anyOf": [
|
|
4336
|
+
{
|
|
4337
|
+
"type": "string"
|
|
4338
|
+
},
|
|
4339
|
+
{
|
|
4340
|
+
"$ref": "#/definitions/ExprRef"
|
|
4341
|
+
}
|
|
4342
|
+
],
|
|
4343
|
+
"description": "One of `\"circle\"`, `\"square\"`, `\"cross\"`, `\"diamond\"`, `\"triangle-up\"`, `\"triangle-down\"`, `\"triangle-right\"`, `\"triangle-left\"`, `\"tick-up\"`, `\"tick-down\"`, `\"tick-right\"`, or `\"tick-left\"`\n\n**Default value:** `\"circle\"`"
|
|
4318
4344
|
},
|
|
4319
4345
|
"size": {
|
|
4320
4346
|
"anyOf": [
|
|
@@ -4347,7 +4373,7 @@
|
|
|
4347
4373
|
"$ref": "#/definitions/ExprRef"
|
|
4348
4374
|
}
|
|
4349
4375
|
],
|
|
4350
|
-
"description": "The stroke opacity. Value between
|
|
4376
|
+
"description": "The stroke opacity. Value between `0` and `1`."
|
|
4351
4377
|
},
|
|
4352
4378
|
"strokeWidth": {
|
|
4353
4379
|
"anyOf": [
|
|
@@ -4362,7 +4388,7 @@
|
|
|
4362
4388
|
},
|
|
4363
4389
|
"tooltip": {
|
|
4364
4390
|
"$ref": "#/definitions/Tooltip",
|
|
4365
|
-
"description": "Tooltip handler. If `null`, no tooltip is shown."
|
|
4391
|
+
"description": "Tooltip handler. If `null`, no tooltip is shown. If string, specifies the [tooltip handler](https://genomespy.app/docs/api/#custom-tooltip-handlers) to use."
|
|
4366
4392
|
},
|
|
4367
4393
|
"type": {
|
|
4368
4394
|
"const": "point",
|
|
@@ -4376,7 +4402,8 @@
|
|
|
4376
4402
|
{
|
|
4377
4403
|
"$ref": "#/definitions/ExprRef"
|
|
4378
4404
|
}
|
|
4379
|
-
]
|
|
4405
|
+
],
|
|
4406
|
+
"description": "Position on the x axis."
|
|
4380
4407
|
},
|
|
4381
4408
|
"xOffset": {
|
|
4382
4409
|
"description": "Offsets of the `x` and `x2` coordinates in pixels. The offset is applied after the viewport scaling and translation.\n\n**Default value:** `0`",
|
|
@@ -4390,7 +4417,8 @@
|
|
|
4390
4417
|
{
|
|
4391
4418
|
"$ref": "#/definitions/ExprRef"
|
|
4392
4419
|
}
|
|
4393
|
-
]
|
|
4420
|
+
],
|
|
4421
|
+
"description": "Position on the y axis."
|
|
4394
4422
|
},
|
|
4395
4423
|
"yOffset": {
|
|
4396
4424
|
"description": "Offsets of the `y` and `y2` coordinates in pixels. The offset is applied after the viewport scaling and translation.\n\n**Default value:** `0`",
|
|
@@ -4809,7 +4837,8 @@
|
|
|
4809
4837
|
{
|
|
4810
4838
|
"$ref": "#/definitions/ExprRef"
|
|
4811
4839
|
}
|
|
4812
|
-
]
|
|
4840
|
+
],
|
|
4841
|
+
"description": "Color of the mark. Affects either `fill` or `stroke`, depending on the `filled` property."
|
|
4813
4842
|
},
|
|
4814
4843
|
"cornerRadius": {
|
|
4815
4844
|
"anyOf": [
|
|
@@ -4875,7 +4904,7 @@
|
|
|
4875
4904
|
"$ref": "#/definitions/ExprRef"
|
|
4876
4905
|
}
|
|
4877
4906
|
],
|
|
4878
|
-
"description": "The fill color"
|
|
4907
|
+
"description": "The fill color."
|
|
4879
4908
|
},
|
|
4880
4909
|
"fillOpacity": {
|
|
4881
4910
|
"anyOf": [
|
|
@@ -4886,7 +4915,7 @@
|
|
|
4886
4915
|
"$ref": "#/definitions/ExprRef"
|
|
4887
4916
|
}
|
|
4888
4917
|
],
|
|
4889
|
-
"description": "The fill opacity. Value between
|
|
4918
|
+
"description": "The fill opacity. Value between `0` and `1`."
|
|
4890
4919
|
},
|
|
4891
4920
|
"filled": {
|
|
4892
4921
|
"description": "Whether the `color` represents the `fill` color (`true`) or the `stroke` color (`false`).",
|
|
@@ -4937,7 +4966,8 @@
|
|
|
4937
4966
|
{
|
|
4938
4967
|
"$ref": "#/definitions/ExprRef"
|
|
4939
4968
|
}
|
|
4940
|
-
]
|
|
4969
|
+
],
|
|
4970
|
+
"description": "Opacity of the mark. Affects `fillOpacity` or `strokeOpacity`, depending on the `filled` property."
|
|
4941
4971
|
},
|
|
4942
4972
|
"stroke": {
|
|
4943
4973
|
"anyOf": [
|
|
@@ -4959,7 +4989,7 @@
|
|
|
4959
4989
|
"$ref": "#/definitions/ExprRef"
|
|
4960
4990
|
}
|
|
4961
4991
|
],
|
|
4962
|
-
"description": "The stroke opacity. Value between
|
|
4992
|
+
"description": "The stroke opacity. Value between `0` and `1`."
|
|
4963
4993
|
},
|
|
4964
4994
|
"strokeWidth": {
|
|
4965
4995
|
"anyOf": [
|
|
@@ -4974,7 +5004,7 @@
|
|
|
4974
5004
|
},
|
|
4975
5005
|
"tooltip": {
|
|
4976
5006
|
"$ref": "#/definitions/Tooltip",
|
|
4977
|
-
"description": "Tooltip handler. If `null`, no tooltip is shown."
|
|
5007
|
+
"description": "Tooltip handler. If `null`, no tooltip is shown. If string, specifies the [tooltip handler](https://genomespy.app/docs/api/#custom-tooltip-handlers) to use."
|
|
4978
5008
|
},
|
|
4979
5009
|
"type": {
|
|
4980
5010
|
"const": "rect",
|
|
@@ -4988,7 +5018,8 @@
|
|
|
4988
5018
|
{
|
|
4989
5019
|
"$ref": "#/definitions/ExprRef"
|
|
4990
5020
|
}
|
|
4991
|
-
]
|
|
5021
|
+
],
|
|
5022
|
+
"description": "Position on the x axis."
|
|
4992
5023
|
},
|
|
4993
5024
|
"x2": {
|
|
4994
5025
|
"anyOf": [
|
|
@@ -4998,7 +5029,8 @@
|
|
|
4998
5029
|
{
|
|
4999
5030
|
"$ref": "#/definitions/ExprRef"
|
|
5000
5031
|
}
|
|
5001
|
-
]
|
|
5032
|
+
],
|
|
5033
|
+
"description": "The secondary position on the x axis."
|
|
5002
5034
|
},
|
|
5003
5035
|
"xOffset": {
|
|
5004
5036
|
"description": "Offsets of the `x` and `x2` coordinates in pixels. The offset is applied after the viewport scaling and translation.\n\n**Default value:** `0`",
|
|
@@ -5012,7 +5044,8 @@
|
|
|
5012
5044
|
{
|
|
5013
5045
|
"$ref": "#/definitions/ExprRef"
|
|
5014
5046
|
}
|
|
5015
|
-
]
|
|
5047
|
+
],
|
|
5048
|
+
"description": "Position on the y axis."
|
|
5016
5049
|
},
|
|
5017
5050
|
"y2": {
|
|
5018
5051
|
"anyOf": [
|
|
@@ -5022,7 +5055,8 @@
|
|
|
5022
5055
|
{
|
|
5023
5056
|
"$ref": "#/definitions/ExprRef"
|
|
5024
5057
|
}
|
|
5025
|
-
]
|
|
5058
|
+
],
|
|
5059
|
+
"description": "The secondary position on the y axis."
|
|
5026
5060
|
},
|
|
5027
5061
|
"yOffset": {
|
|
5028
5062
|
"description": "Offsets of the `y` and `y2` coordinates in pixels. The offset is applied after the viewport scaling and translation.\n\n**Default value:** `0`",
|
|
@@ -5148,6 +5182,7 @@
|
|
|
5148
5182
|
"type": "string"
|
|
5149
5183
|
},
|
|
5150
5184
|
"aggregateSamples": {
|
|
5185
|
+
"description": "Specifies views that [aggregate](https://genomespy.app/docs/sample-collections/visualizing/#aggregation) multiple samples within the GenomeSpy App.",
|
|
5151
5186
|
"items": {
|
|
5152
5187
|
"anyOf": [
|
|
5153
5188
|
{
|
|
@@ -5165,15 +5200,16 @@
|
|
|
5165
5200
|
"type": "string"
|
|
5166
5201
|
},
|
|
5167
5202
|
"baseUrl": {
|
|
5168
|
-
"description": "
|
|
5203
|
+
"description": "The base URL for relative URL data sources and URL [imports](https://genomespy.app/docs/grammar/import/#importing-from-a-url). The base URLs are inherited in the view hierarchy unless overridden with this property. By default, the top-level view's base URL equals to the visualization specification's base URL.",
|
|
5169
5204
|
"type": "string"
|
|
5170
5205
|
},
|
|
5171
5206
|
"configurableVisibility": {
|
|
5172
|
-
"description": "Is the visibility configurable interactively from the App. Configurability requires that the view has an explicitly specified name that is *unique* in within the view
|
|
5207
|
+
"description": "Is the visibility configurable interactively from the [GenomeSpy App](https://genomespy.app/docs/sample-collections/). Configurability requires that the view has an explicitly specified name that is *unique* in within the view hierarchy.\n\n**Default:** `false` for children of `layer`, `true` for others.",
|
|
5173
5208
|
"type": "boolean"
|
|
5174
5209
|
},
|
|
5175
5210
|
"data": {
|
|
5176
|
-
"$ref": "#/definitions/Data"
|
|
5211
|
+
"$ref": "#/definitions/Data",
|
|
5212
|
+
"description": "Specifies a [data source](https://genomespy.app/docs/grammar/data/). If omitted, the data source is inherited from the parent view."
|
|
5177
5213
|
},
|
|
5178
5214
|
"datasets": {
|
|
5179
5215
|
"additionalProperties": {
|
|
@@ -5195,10 +5231,11 @@
|
|
|
5195
5231
|
"type": "array"
|
|
5196
5232
|
}
|
|
5197
5233
|
],
|
|
5198
|
-
"description": "A description of the view.
|
|
5234
|
+
"description": "A description of the view. Can be used for documentation. The description of the top-level view is shown in the toolbar of the [GenomeSpy App](https://genomespy.app/docs/sample-collections/)."
|
|
5199
5235
|
},
|
|
5200
5236
|
"encoding": {
|
|
5201
|
-
"$ref": "#/definitions/Encoding"
|
|
5237
|
+
"$ref": "#/definitions/Encoding",
|
|
5238
|
+
"description": "Specifies how data are [encoded](https://genomespy.app/docs/grammar/mark/#encoding) using the visual channels."
|
|
5202
5239
|
},
|
|
5203
5240
|
"genome": {
|
|
5204
5241
|
"$ref": "#/definitions/GenomeConfig"
|
|
@@ -5219,7 +5256,7 @@
|
|
|
5219
5256
|
"type": "string"
|
|
5220
5257
|
}
|
|
5221
5258
|
],
|
|
5222
|
-
"description": "Height of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
5259
|
+
"description": "Height of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default value:** `\"container\"`"
|
|
5223
5260
|
},
|
|
5224
5261
|
"mark": {
|
|
5225
5262
|
"anyOf": [
|
|
@@ -5229,21 +5266,23 @@
|
|
|
5229
5266
|
{
|
|
5230
5267
|
"$ref": "#/definitions/MarkProps"
|
|
5231
5268
|
}
|
|
5232
|
-
]
|
|
5269
|
+
],
|
|
5270
|
+
"description": "The graphical mark presenting the data objects."
|
|
5233
5271
|
},
|
|
5234
5272
|
"name": {
|
|
5273
|
+
"description": "An internal name that can be used for referring the view. For referencing purposes, the name should be unique within the view hierarchy.",
|
|
5235
5274
|
"type": "string"
|
|
5236
5275
|
},
|
|
5237
5276
|
"opacity": {
|
|
5238
5277
|
"$ref": "#/definitions/ViewOpacityDef",
|
|
5239
|
-
"description": "Opacity of the view and all its children.\n\n**Default:** `1.0`"
|
|
5278
|
+
"description": "Opacity of the view and all its children. Allows implementing semantic zooming where the layers are faded in and out as the user zooms in and out.\n\nTODO: Write proper documentation with examples.\n\n**Default:** `1.0`"
|
|
5240
5279
|
},
|
|
5241
5280
|
"padding": {
|
|
5242
5281
|
"$ref": "#/definitions/PaddingConfig",
|
|
5243
|
-
"description": "Padding
|
|
5282
|
+
"description": "Padding applied to the view. Accepts either a number representing pixels or an object specifying separate paddings for each edge.\n\nExamples:\n- `padding: 10`\n- `padding: { top: 10, right: 20, bottom: 10, left: 20 }`\n\n**Default value:** `0`"
|
|
5244
5283
|
},
|
|
5245
5284
|
"params": {
|
|
5246
|
-
"description": "Dynamic variables that parameterize a visualization.",
|
|
5285
|
+
"description": "Dynamic variables that [parameterize](https://genomespy.app/docs/grammar/parameters/) a visualization.",
|
|
5247
5286
|
"items": {
|
|
5248
5287
|
"$ref": "#/definitions/Parameter"
|
|
5249
5288
|
},
|
|
@@ -5251,6 +5290,7 @@
|
|
|
5251
5290
|
},
|
|
5252
5291
|
"resolve": {
|
|
5253
5292
|
"additionalProperties": false,
|
|
5293
|
+
"description": "Specifies how scales and axes are [resolved](https://genomespy.app/docs/grammar/composition/#scale-and-axis-resolution) in the view hierarchy.",
|
|
5254
5294
|
"properties": {
|
|
5255
5295
|
"axis": {
|
|
5256
5296
|
"additionalProperties": {
|
|
@@ -5281,7 +5321,7 @@
|
|
|
5281
5321
|
"additionalProperties": {
|
|
5282
5322
|
"$ref": "#/definitions/ViewSpec"
|
|
5283
5323
|
},
|
|
5284
|
-
"description": "Templates that can be reused within the view specification by importing them with the template key.",
|
|
5324
|
+
"description": "[Templates](https://genomespy.app/docs/grammar/import/#repeating-with-named-templates) that can be reused within the view specification by importing them with the template key.",
|
|
5285
5325
|
"type": "object"
|
|
5286
5326
|
},
|
|
5287
5327
|
"title": {
|
|
@@ -5292,16 +5332,19 @@
|
|
|
5292
5332
|
{
|
|
5293
5333
|
"$ref": "#/definitions/Title"
|
|
5294
5334
|
}
|
|
5295
|
-
]
|
|
5335
|
+
],
|
|
5336
|
+
"description": "View title. N.B.: Currently, GenomeSpy doesn't do bound calculation, and you need to manually specify proper padding for the view to ensure that the title is visible."
|
|
5296
5337
|
},
|
|
5297
5338
|
"transform": {
|
|
5339
|
+
"description": "An array of [transformations](https://genomespy.app/docs/grammar/transform/) applied to the data before visual encoding.",
|
|
5298
5340
|
"items": {
|
|
5299
5341
|
"$ref": "#/definitions/TransformParams"
|
|
5300
5342
|
},
|
|
5301
5343
|
"type": "array"
|
|
5302
5344
|
},
|
|
5303
5345
|
"view": {
|
|
5304
|
-
"$ref": "#/definitions/ViewBackground"
|
|
5346
|
+
"$ref": "#/definitions/ViewBackground",
|
|
5347
|
+
"description": "The background of the view, including fill, stroke, and stroke width."
|
|
5305
5348
|
},
|
|
5306
5349
|
"viewportHeight": {
|
|
5307
5350
|
"anyOf": [
|
|
@@ -5316,7 +5359,7 @@
|
|
|
5316
5359
|
"type": "string"
|
|
5317
5360
|
}
|
|
5318
5361
|
],
|
|
5319
|
-
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
5362
|
+
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
5320
5363
|
},
|
|
5321
5364
|
"viewportWidth": {
|
|
5322
5365
|
"anyOf": [
|
|
@@ -5331,10 +5374,10 @@
|
|
|
5331
5374
|
"type": "string"
|
|
5332
5375
|
}
|
|
5333
5376
|
],
|
|
5334
|
-
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
5377
|
+
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
5335
5378
|
},
|
|
5336
5379
|
"visible": {
|
|
5337
|
-
"description": "
|
|
5380
|
+
"description": "The default visibility of the view. An invisible view is removed from the layout and not rendered. For context, see [toggleable view visibility](https://genomespy.app/docs/sample-collections/visualizing/#toggleable-view-visibility).\n\n**Default:** `true`",
|
|
5338
5381
|
"type": "boolean"
|
|
5339
5382
|
},
|
|
5340
5383
|
"width": {
|
|
@@ -5353,7 +5396,7 @@
|
|
|
5353
5396
|
"type": "string"
|
|
5354
5397
|
}
|
|
5355
5398
|
],
|
|
5356
|
-
"description": "Width of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
5399
|
+
"description": "Width of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default:** `\"container\"`"
|
|
5357
5400
|
}
|
|
5358
5401
|
},
|
|
5359
5402
|
"required": [
|
|
@@ -5368,6 +5411,7 @@
|
|
|
5368
5411
|
"type": "string"
|
|
5369
5412
|
},
|
|
5370
5413
|
"aggregateSamples": {
|
|
5414
|
+
"description": "Specifies views that [aggregate](https://genomespy.app/docs/sample-collections/visualizing/#aggregation) multiple samples within the GenomeSpy App.",
|
|
5371
5415
|
"items": {
|
|
5372
5416
|
"anyOf": [
|
|
5373
5417
|
{
|
|
@@ -5385,15 +5429,16 @@
|
|
|
5385
5429
|
"type": "string"
|
|
5386
5430
|
},
|
|
5387
5431
|
"baseUrl": {
|
|
5388
|
-
"description": "
|
|
5432
|
+
"description": "The base URL for relative URL data sources and URL [imports](https://genomespy.app/docs/grammar/import/#importing-from-a-url). The base URLs are inherited in the view hierarchy unless overridden with this property. By default, the top-level view's base URL equals to the visualization specification's base URL.",
|
|
5389
5433
|
"type": "string"
|
|
5390
5434
|
},
|
|
5391
5435
|
"configurableVisibility": {
|
|
5392
|
-
"description": "Is the visibility configurable interactively from the App. Configurability requires that the view has an explicitly specified name that is *unique* in within the view
|
|
5436
|
+
"description": "Is the visibility configurable interactively from the [GenomeSpy App](https://genomespy.app/docs/sample-collections/). Configurability requires that the view has an explicitly specified name that is *unique* in within the view hierarchy.\n\n**Default:** `false` for children of `layer`, `true` for others.",
|
|
5393
5437
|
"type": "boolean"
|
|
5394
5438
|
},
|
|
5395
5439
|
"data": {
|
|
5396
|
-
"$ref": "#/definitions/Data"
|
|
5440
|
+
"$ref": "#/definitions/Data",
|
|
5441
|
+
"description": "Specifies a [data source](https://genomespy.app/docs/grammar/data/). If omitted, the data source is inherited from the parent view."
|
|
5397
5442
|
},
|
|
5398
5443
|
"datasets": {
|
|
5399
5444
|
"additionalProperties": {
|
|
@@ -5415,10 +5460,11 @@
|
|
|
5415
5460
|
"type": "array"
|
|
5416
5461
|
}
|
|
5417
5462
|
],
|
|
5418
|
-
"description": "A description of the view.
|
|
5463
|
+
"description": "A description of the view. Can be used for documentation. The description of the top-level view is shown in the toolbar of the [GenomeSpy App](https://genomespy.app/docs/sample-collections/)."
|
|
5419
5464
|
},
|
|
5420
5465
|
"encoding": {
|
|
5421
|
-
"$ref": "#/definitions/Encoding"
|
|
5466
|
+
"$ref": "#/definitions/Encoding",
|
|
5467
|
+
"description": "Specifies how data are [encoded](https://genomespy.app/docs/grammar/mark/#encoding) using the visual channels."
|
|
5422
5468
|
},
|
|
5423
5469
|
"genome": {
|
|
5424
5470
|
"$ref": "#/definitions/GenomeConfig"
|
|
@@ -5439,7 +5485,7 @@
|
|
|
5439
5485
|
"type": "string"
|
|
5440
5486
|
}
|
|
5441
5487
|
],
|
|
5442
|
-
"description": "Height of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
5488
|
+
"description": "Height of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default value:** `\"container\"`"
|
|
5443
5489
|
},
|
|
5444
5490
|
"layer": {
|
|
5445
5491
|
"items": {
|
|
@@ -5458,18 +5504,19 @@
|
|
|
5458
5504
|
"type": "array"
|
|
5459
5505
|
},
|
|
5460
5506
|
"name": {
|
|
5507
|
+
"description": "An internal name that can be used for referring the view. For referencing purposes, the name should be unique within the view hierarchy.",
|
|
5461
5508
|
"type": "string"
|
|
5462
5509
|
},
|
|
5463
5510
|
"opacity": {
|
|
5464
5511
|
"$ref": "#/definitions/ViewOpacityDef",
|
|
5465
|
-
"description": "Opacity of the view and all its children.\n\n**Default:** `1.0`"
|
|
5512
|
+
"description": "Opacity of the view and all its children. Allows implementing semantic zooming where the layers are faded in and out as the user zooms in and out.\n\nTODO: Write proper documentation with examples.\n\n**Default:** `1.0`"
|
|
5466
5513
|
},
|
|
5467
5514
|
"padding": {
|
|
5468
5515
|
"$ref": "#/definitions/PaddingConfig",
|
|
5469
|
-
"description": "Padding
|
|
5516
|
+
"description": "Padding applied to the view. Accepts either a number representing pixels or an object specifying separate paddings for each edge.\n\nExamples:\n- `padding: 10`\n- `padding: { top: 10, right: 20, bottom: 10, left: 20 }`\n\n**Default value:** `0`"
|
|
5470
5517
|
},
|
|
5471
5518
|
"params": {
|
|
5472
|
-
"description": "Dynamic variables that parameterize a visualization.",
|
|
5519
|
+
"description": "Dynamic variables that [parameterize](https://genomespy.app/docs/grammar/parameters/) a visualization.",
|
|
5473
5520
|
"items": {
|
|
5474
5521
|
"$ref": "#/definitions/Parameter"
|
|
5475
5522
|
},
|
|
@@ -5477,6 +5524,7 @@
|
|
|
5477
5524
|
},
|
|
5478
5525
|
"resolve": {
|
|
5479
5526
|
"additionalProperties": false,
|
|
5527
|
+
"description": "Specifies how scales and axes are [resolved](https://genomespy.app/docs/grammar/composition/#scale-and-axis-resolution) in the view hierarchy.",
|
|
5480
5528
|
"properties": {
|
|
5481
5529
|
"axis": {
|
|
5482
5530
|
"additionalProperties": {
|
|
@@ -5507,7 +5555,7 @@
|
|
|
5507
5555
|
"additionalProperties": {
|
|
5508
5556
|
"$ref": "#/definitions/ViewSpec"
|
|
5509
5557
|
},
|
|
5510
|
-
"description": "Templates that can be reused within the view specification by importing them with the template key.",
|
|
5558
|
+
"description": "[Templates](https://genomespy.app/docs/grammar/import/#repeating-with-named-templates) that can be reused within the view specification by importing them with the template key.",
|
|
5511
5559
|
"type": "object"
|
|
5512
5560
|
},
|
|
5513
5561
|
"title": {
|
|
@@ -5518,9 +5566,11 @@
|
|
|
5518
5566
|
{
|
|
5519
5567
|
"$ref": "#/definitions/Title"
|
|
5520
5568
|
}
|
|
5521
|
-
]
|
|
5569
|
+
],
|
|
5570
|
+
"description": "View title. N.B.: Currently, GenomeSpy doesn't do bound calculation, and you need to manually specify proper padding for the view to ensure that the title is visible."
|
|
5522
5571
|
},
|
|
5523
5572
|
"transform": {
|
|
5573
|
+
"description": "An array of [transformations](https://genomespy.app/docs/grammar/transform/) applied to the data before visual encoding.",
|
|
5524
5574
|
"items": {
|
|
5525
5575
|
"$ref": "#/definitions/TransformParams"
|
|
5526
5576
|
},
|
|
@@ -5542,7 +5592,7 @@
|
|
|
5542
5592
|
"type": "string"
|
|
5543
5593
|
}
|
|
5544
5594
|
],
|
|
5545
|
-
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
5595
|
+
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
5546
5596
|
},
|
|
5547
5597
|
"viewportWidth": {
|
|
5548
5598
|
"anyOf": [
|
|
@@ -5557,10 +5607,10 @@
|
|
|
5557
5607
|
"type": "string"
|
|
5558
5608
|
}
|
|
5559
5609
|
],
|
|
5560
|
-
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
5610
|
+
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
5561
5611
|
},
|
|
5562
5612
|
"visible": {
|
|
5563
|
-
"description": "
|
|
5613
|
+
"description": "The default visibility of the view. An invisible view is removed from the layout and not rendered. For context, see [toggleable view visibility](https://genomespy.app/docs/sample-collections/visualizing/#toggleable-view-visibility).\n\n**Default:** `true`",
|
|
5564
5614
|
"type": "boolean"
|
|
5565
5615
|
},
|
|
5566
5616
|
"width": {
|
|
@@ -5579,7 +5629,7 @@
|
|
|
5579
5629
|
"type": "string"
|
|
5580
5630
|
}
|
|
5581
5631
|
],
|
|
5582
|
-
"description": "Width of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
5632
|
+
"description": "Width of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default:** `\"container\"`"
|
|
5583
5633
|
}
|
|
5584
5634
|
},
|
|
5585
5635
|
"required": [
|
|
@@ -5598,15 +5648,16 @@
|
|
|
5598
5648
|
"type": "string"
|
|
5599
5649
|
},
|
|
5600
5650
|
"baseUrl": {
|
|
5601
|
-
"description": "
|
|
5651
|
+
"description": "The base URL for relative URL data sources and URL [imports](https://genomespy.app/docs/grammar/import/#importing-from-a-url). The base URLs are inherited in the view hierarchy unless overridden with this property. By default, the top-level view's base URL equals to the visualization specification's base URL.",
|
|
5602
5652
|
"type": "string"
|
|
5603
5653
|
},
|
|
5604
5654
|
"configurableVisibility": {
|
|
5605
|
-
"description": "Is the visibility configurable interactively from the App. Configurability requires that the view has an explicitly specified name that is *unique* in within the view
|
|
5655
|
+
"description": "Is the visibility configurable interactively from the [GenomeSpy App](https://genomespy.app/docs/sample-collections/). Configurability requires that the view has an explicitly specified name that is *unique* in within the view hierarchy.\n\n**Default:** `false` for children of `layer`, `true` for others.",
|
|
5606
5656
|
"type": "boolean"
|
|
5607
5657
|
},
|
|
5608
5658
|
"data": {
|
|
5609
|
-
"$ref": "#/definitions/Data"
|
|
5659
|
+
"$ref": "#/definitions/Data",
|
|
5660
|
+
"description": "Specifies a [data source](https://genomespy.app/docs/grammar/data/). If omitted, the data source is inherited from the parent view."
|
|
5610
5661
|
},
|
|
5611
5662
|
"datasets": {
|
|
5612
5663
|
"additionalProperties": {
|
|
@@ -5628,10 +5679,11 @@
|
|
|
5628
5679
|
"type": "array"
|
|
5629
5680
|
}
|
|
5630
5681
|
],
|
|
5631
|
-
"description": "A description of the view.
|
|
5682
|
+
"description": "A description of the view. Can be used for documentation. The description of the top-level view is shown in the toolbar of the [GenomeSpy App](https://genomespy.app/docs/sample-collections/)."
|
|
5632
5683
|
},
|
|
5633
5684
|
"encoding": {
|
|
5634
|
-
"$ref": "#/definitions/Encoding"
|
|
5685
|
+
"$ref": "#/definitions/Encoding",
|
|
5686
|
+
"description": "Specifies how data are [encoded](https://genomespy.app/docs/grammar/mark/#encoding) using the visual channels."
|
|
5635
5687
|
},
|
|
5636
5688
|
"genome": {
|
|
5637
5689
|
"$ref": "#/definitions/GenomeConfig"
|
|
@@ -5652,21 +5704,18 @@
|
|
|
5652
5704
|
"type": "string"
|
|
5653
5705
|
}
|
|
5654
5706
|
],
|
|
5655
|
-
"description": "Height of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
5707
|
+
"description": "Height of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default value:** `\"container\"`"
|
|
5656
5708
|
},
|
|
5657
5709
|
"name": {
|
|
5710
|
+
"description": "An internal name that can be used for referring the view. For referencing purposes, the name should be unique within the view hierarchy.",
|
|
5658
5711
|
"type": "string"
|
|
5659
5712
|
},
|
|
5660
|
-
"opacity": {
|
|
5661
|
-
"$ref": "#/definitions/ViewOpacityDef",
|
|
5662
|
-
"description": "Opacity of the view and all its children.\n\n**Default:** `1.0`"
|
|
5663
|
-
},
|
|
5664
5713
|
"padding": {
|
|
5665
5714
|
"$ref": "#/definitions/PaddingConfig",
|
|
5666
|
-
"description": "Padding
|
|
5715
|
+
"description": "Padding applied to the view. Accepts either a number representing pixels or an object specifying separate paddings for each edge.\n\nExamples:\n- `padding: 10`\n- `padding: { top: 10, right: 20, bottom: 10, left: 20 }`\n\n**Default value:** `0`"
|
|
5667
5716
|
},
|
|
5668
5717
|
"params": {
|
|
5669
|
-
"description": "Dynamic variables that parameterize a visualization.",
|
|
5718
|
+
"description": "Dynamic variables that [parameterize](https://genomespy.app/docs/grammar/parameters/) a visualization.",
|
|
5670
5719
|
"items": {
|
|
5671
5720
|
"$ref": "#/definitions/Parameter"
|
|
5672
5721
|
},
|
|
@@ -5674,6 +5723,7 @@
|
|
|
5674
5723
|
},
|
|
5675
5724
|
"resolve": {
|
|
5676
5725
|
"additionalProperties": false,
|
|
5726
|
+
"description": "Specifies how scales and axes are [resolved](https://genomespy.app/docs/grammar/composition/#scale-and-axis-resolution) in the view hierarchy.",
|
|
5677
5727
|
"properties": {
|
|
5678
5728
|
"axis": {
|
|
5679
5729
|
"additionalProperties": {
|
|
@@ -5708,7 +5758,7 @@
|
|
|
5708
5758
|
"additionalProperties": {
|
|
5709
5759
|
"$ref": "#/definitions/ViewSpec"
|
|
5710
5760
|
},
|
|
5711
|
-
"description": "Templates that can be reused within the view specification by importing them with the template key.",
|
|
5761
|
+
"description": "[Templates](https://genomespy.app/docs/grammar/import/#repeating-with-named-templates) that can be reused within the view specification by importing them with the template key.",
|
|
5712
5762
|
"type": "object"
|
|
5713
5763
|
},
|
|
5714
5764
|
"title": {
|
|
@@ -5719,9 +5769,11 @@
|
|
|
5719
5769
|
{
|
|
5720
5770
|
"$ref": "#/definitions/Title"
|
|
5721
5771
|
}
|
|
5722
|
-
]
|
|
5772
|
+
],
|
|
5773
|
+
"description": "View title. N.B.: Currently, GenomeSpy doesn't do bound calculation, and you need to manually specify proper padding for the view to ensure that the title is visible."
|
|
5723
5774
|
},
|
|
5724
5775
|
"transform": {
|
|
5776
|
+
"description": "An array of [transformations](https://genomespy.app/docs/grammar/transform/) applied to the data before visual encoding.",
|
|
5725
5777
|
"items": {
|
|
5726
5778
|
"$ref": "#/definitions/TransformParams"
|
|
5727
5779
|
},
|
|
@@ -5754,7 +5806,7 @@
|
|
|
5754
5806
|
"type": "string"
|
|
5755
5807
|
}
|
|
5756
5808
|
],
|
|
5757
|
-
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
5809
|
+
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
5758
5810
|
},
|
|
5759
5811
|
"viewportWidth": {
|
|
5760
5812
|
"anyOf": [
|
|
@@ -5769,10 +5821,10 @@
|
|
|
5769
5821
|
"type": "string"
|
|
5770
5822
|
}
|
|
5771
5823
|
],
|
|
5772
|
-
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
5824
|
+
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
5773
5825
|
},
|
|
5774
5826
|
"visible": {
|
|
5775
|
-
"description": "
|
|
5827
|
+
"description": "The default visibility of the view. An invisible view is removed from the layout and not rendered. For context, see [toggleable view visibility](https://genomespy.app/docs/sample-collections/visualizing/#toggleable-view-visibility).\n\n**Default:** `true`",
|
|
5776
5828
|
"type": "boolean"
|
|
5777
5829
|
},
|
|
5778
5830
|
"width": {
|
|
@@ -5791,7 +5843,7 @@
|
|
|
5791
5843
|
"type": "string"
|
|
5792
5844
|
}
|
|
5793
5845
|
],
|
|
5794
|
-
"description": "Width of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
5846
|
+
"description": "Width of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default:** `\"container\"`"
|
|
5795
5847
|
}
|
|
5796
5848
|
},
|
|
5797
5849
|
"required": [
|
|
@@ -5810,15 +5862,16 @@
|
|
|
5810
5862
|
"type": "string"
|
|
5811
5863
|
},
|
|
5812
5864
|
"baseUrl": {
|
|
5813
|
-
"description": "
|
|
5865
|
+
"description": "The base URL for relative URL data sources and URL [imports](https://genomespy.app/docs/grammar/import/#importing-from-a-url). The base URLs are inherited in the view hierarchy unless overridden with this property. By default, the top-level view's base URL equals to the visualization specification's base URL.",
|
|
5814
5866
|
"type": "string"
|
|
5815
5867
|
},
|
|
5816
5868
|
"configurableVisibility": {
|
|
5817
|
-
"description": "Is the visibility configurable interactively from the App. Configurability requires that the view has an explicitly specified name that is *unique* in within the view
|
|
5869
|
+
"description": "Is the visibility configurable interactively from the [GenomeSpy App](https://genomespy.app/docs/sample-collections/). Configurability requires that the view has an explicitly specified name that is *unique* in within the view hierarchy.\n\n**Default:** `false` for children of `layer`, `true` for others.",
|
|
5818
5870
|
"type": "boolean"
|
|
5819
5871
|
},
|
|
5820
5872
|
"data": {
|
|
5821
|
-
"$ref": "#/definitions/Data"
|
|
5873
|
+
"$ref": "#/definitions/Data",
|
|
5874
|
+
"description": "Specifies a [data source](https://genomespy.app/docs/grammar/data/). If omitted, the data source is inherited from the parent view."
|
|
5822
5875
|
},
|
|
5823
5876
|
"datasets": {
|
|
5824
5877
|
"additionalProperties": {
|
|
@@ -5840,10 +5893,11 @@
|
|
|
5840
5893
|
"type": "array"
|
|
5841
5894
|
}
|
|
5842
5895
|
],
|
|
5843
|
-
"description": "A description of the view.
|
|
5896
|
+
"description": "A description of the view. Can be used for documentation. The description of the top-level view is shown in the toolbar of the [GenomeSpy App](https://genomespy.app/docs/sample-collections/)."
|
|
5844
5897
|
},
|
|
5845
5898
|
"encoding": {
|
|
5846
|
-
"$ref": "#/definitions/Encoding"
|
|
5899
|
+
"$ref": "#/definitions/Encoding",
|
|
5900
|
+
"description": "Specifies how data are [encoded](https://genomespy.app/docs/grammar/mark/#encoding) using the visual channels."
|
|
5847
5901
|
},
|
|
5848
5902
|
"genome": {
|
|
5849
5903
|
"$ref": "#/definitions/GenomeConfig"
|
|
@@ -5878,21 +5932,18 @@
|
|
|
5878
5932
|
"type": "string"
|
|
5879
5933
|
}
|
|
5880
5934
|
],
|
|
5881
|
-
"description": "Height of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
5935
|
+
"description": "Height of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default value:** `\"container\"`"
|
|
5882
5936
|
},
|
|
5883
5937
|
"name": {
|
|
5938
|
+
"description": "An internal name that can be used for referring the view. For referencing purposes, the name should be unique within the view hierarchy.",
|
|
5884
5939
|
"type": "string"
|
|
5885
5940
|
},
|
|
5886
|
-
"opacity": {
|
|
5887
|
-
"$ref": "#/definitions/ViewOpacityDef",
|
|
5888
|
-
"description": "Opacity of the view and all its children.\n\n**Default:** `1.0`"
|
|
5889
|
-
},
|
|
5890
5941
|
"padding": {
|
|
5891
5942
|
"$ref": "#/definitions/PaddingConfig",
|
|
5892
|
-
"description": "Padding
|
|
5943
|
+
"description": "Padding applied to the view. Accepts either a number representing pixels or an object specifying separate paddings for each edge.\n\nExamples:\n- `padding: 10`\n- `padding: { top: 10, right: 20, bottom: 10, left: 20 }`\n\n**Default value:** `0`"
|
|
5893
5944
|
},
|
|
5894
5945
|
"params": {
|
|
5895
|
-
"description": "Dynamic variables that parameterize a visualization.",
|
|
5946
|
+
"description": "Dynamic variables that [parameterize](https://genomespy.app/docs/grammar/parameters/) a visualization.",
|
|
5896
5947
|
"items": {
|
|
5897
5948
|
"$ref": "#/definitions/Parameter"
|
|
5898
5949
|
},
|
|
@@ -5900,6 +5951,7 @@
|
|
|
5900
5951
|
},
|
|
5901
5952
|
"resolve": {
|
|
5902
5953
|
"additionalProperties": false,
|
|
5954
|
+
"description": "Specifies how scales and axes are [resolved](https://genomespy.app/docs/grammar/composition/#scale-and-axis-resolution) in the view hierarchy.",
|
|
5903
5955
|
"properties": {
|
|
5904
5956
|
"axis": {
|
|
5905
5957
|
"additionalProperties": {
|
|
@@ -5934,7 +5986,7 @@
|
|
|
5934
5986
|
"additionalProperties": {
|
|
5935
5987
|
"$ref": "#/definitions/ViewSpec"
|
|
5936
5988
|
},
|
|
5937
|
-
"description": "Templates that can be reused within the view specification by importing them with the template key.",
|
|
5989
|
+
"description": "[Templates](https://genomespy.app/docs/grammar/import/#repeating-with-named-templates) that can be reused within the view specification by importing them with the template key.",
|
|
5938
5990
|
"type": "object"
|
|
5939
5991
|
},
|
|
5940
5992
|
"title": {
|
|
@@ -5945,9 +5997,11 @@
|
|
|
5945
5997
|
{
|
|
5946
5998
|
"$ref": "#/definitions/Title"
|
|
5947
5999
|
}
|
|
5948
|
-
]
|
|
6000
|
+
],
|
|
6001
|
+
"description": "View title. N.B.: Currently, GenomeSpy doesn't do bound calculation, and you need to manually specify proper padding for the view to ensure that the title is visible."
|
|
5949
6002
|
},
|
|
5950
6003
|
"transform": {
|
|
6004
|
+
"description": "An array of [transformations](https://genomespy.app/docs/grammar/transform/) applied to the data before visual encoding.",
|
|
5951
6005
|
"items": {
|
|
5952
6006
|
"$ref": "#/definitions/TransformParams"
|
|
5953
6007
|
},
|
|
@@ -5966,7 +6020,7 @@
|
|
|
5966
6020
|
"type": "string"
|
|
5967
6021
|
}
|
|
5968
6022
|
],
|
|
5969
|
-
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
6023
|
+
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
5970
6024
|
},
|
|
5971
6025
|
"viewportWidth": {
|
|
5972
6026
|
"anyOf": [
|
|
@@ -5981,10 +6035,10 @@
|
|
|
5981
6035
|
"type": "string"
|
|
5982
6036
|
}
|
|
5983
6037
|
],
|
|
5984
|
-
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
6038
|
+
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
5985
6039
|
},
|
|
5986
6040
|
"visible": {
|
|
5987
|
-
"description": "
|
|
6041
|
+
"description": "The default visibility of the view. An invisible view is removed from the layout and not rendered. For context, see [toggleable view visibility](https://genomespy.app/docs/sample-collections/visualizing/#toggleable-view-visibility).\n\n**Default:** `true`",
|
|
5988
6042
|
"type": "boolean"
|
|
5989
6043
|
},
|
|
5990
6044
|
"width": {
|
|
@@ -6003,7 +6057,7 @@
|
|
|
6003
6057
|
"type": "string"
|
|
6004
6058
|
}
|
|
6005
6059
|
],
|
|
6006
|
-
"description": "Width of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
6060
|
+
"description": "Width of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default:** `\"container\"`"
|
|
6007
6061
|
}
|
|
6008
6062
|
},
|
|
6009
6063
|
"required": [
|
|
@@ -6022,7 +6076,7 @@
|
|
|
6022
6076
|
"type": "string"
|
|
6023
6077
|
},
|
|
6024
6078
|
"baseUrl": {
|
|
6025
|
-
"description": "
|
|
6079
|
+
"description": "The base URL for relative URL data sources and URL [imports](https://genomespy.app/docs/grammar/import/#importing-from-a-url). The base URLs are inherited in the view hierarchy unless overridden with this property. By default, the top-level view's base URL equals to the visualization specification's base URL.",
|
|
6026
6080
|
"type": "string"
|
|
6027
6081
|
},
|
|
6028
6082
|
"columns": {
|
|
@@ -6044,11 +6098,12 @@
|
|
|
6044
6098
|
"type": "array"
|
|
6045
6099
|
},
|
|
6046
6100
|
"configurableVisibility": {
|
|
6047
|
-
"description": "Is the visibility configurable interactively from the App. Configurability requires that the view has an explicitly specified name that is *unique* in within the view
|
|
6101
|
+
"description": "Is the visibility configurable interactively from the [GenomeSpy App](https://genomespy.app/docs/sample-collections/). Configurability requires that the view has an explicitly specified name that is *unique* in within the view hierarchy.\n\n**Default:** `false` for children of `layer`, `true` for others.",
|
|
6048
6102
|
"type": "boolean"
|
|
6049
6103
|
},
|
|
6050
6104
|
"data": {
|
|
6051
|
-
"$ref": "#/definitions/Data"
|
|
6105
|
+
"$ref": "#/definitions/Data",
|
|
6106
|
+
"description": "Specifies a [data source](https://genomespy.app/docs/grammar/data/). If omitted, the data source is inherited from the parent view."
|
|
6052
6107
|
},
|
|
6053
6108
|
"datasets": {
|
|
6054
6109
|
"additionalProperties": {
|
|
@@ -6070,10 +6125,11 @@
|
|
|
6070
6125
|
"type": "array"
|
|
6071
6126
|
}
|
|
6072
6127
|
],
|
|
6073
|
-
"description": "A description of the view.
|
|
6128
|
+
"description": "A description of the view. Can be used for documentation. The description of the top-level view is shown in the toolbar of the [GenomeSpy App](https://genomespy.app/docs/sample-collections/)."
|
|
6074
6129
|
},
|
|
6075
6130
|
"encoding": {
|
|
6076
|
-
"$ref": "#/definitions/Encoding"
|
|
6131
|
+
"$ref": "#/definitions/Encoding",
|
|
6132
|
+
"description": "Specifies how data are [encoded](https://genomespy.app/docs/grammar/mark/#encoding) using the visual channels."
|
|
6077
6133
|
},
|
|
6078
6134
|
"genome": {
|
|
6079
6135
|
"$ref": "#/definitions/GenomeConfig"
|
|
@@ -6094,21 +6150,18 @@
|
|
|
6094
6150
|
"type": "string"
|
|
6095
6151
|
}
|
|
6096
6152
|
],
|
|
6097
|
-
"description": "Height of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
6153
|
+
"description": "Height of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default value:** `\"container\"`"
|
|
6098
6154
|
},
|
|
6099
6155
|
"name": {
|
|
6156
|
+
"description": "An internal name that can be used for referring the view. For referencing purposes, the name should be unique within the view hierarchy.",
|
|
6100
6157
|
"type": "string"
|
|
6101
6158
|
},
|
|
6102
|
-
"opacity": {
|
|
6103
|
-
"$ref": "#/definitions/ViewOpacityDef",
|
|
6104
|
-
"description": "Opacity of the view and all its children.\n\n**Default:** `1.0`"
|
|
6105
|
-
},
|
|
6106
6159
|
"padding": {
|
|
6107
6160
|
"$ref": "#/definitions/PaddingConfig",
|
|
6108
|
-
"description": "Padding
|
|
6161
|
+
"description": "Padding applied to the view. Accepts either a number representing pixels or an object specifying separate paddings for each edge.\n\nExamples:\n- `padding: 10`\n- `padding: { top: 10, right: 20, bottom: 10, left: 20 }`\n\n**Default value:** `0`"
|
|
6109
6162
|
},
|
|
6110
6163
|
"params": {
|
|
6111
|
-
"description": "Dynamic variables that parameterize a visualization.",
|
|
6164
|
+
"description": "Dynamic variables that [parameterize](https://genomespy.app/docs/grammar/parameters/) a visualization.",
|
|
6112
6165
|
"items": {
|
|
6113
6166
|
"$ref": "#/definitions/Parameter"
|
|
6114
6167
|
},
|
|
@@ -6116,6 +6169,7 @@
|
|
|
6116
6169
|
},
|
|
6117
6170
|
"resolve": {
|
|
6118
6171
|
"additionalProperties": false,
|
|
6172
|
+
"description": "Specifies how scales and axes are [resolved](https://genomespy.app/docs/grammar/composition/#scale-and-axis-resolution) in the view hierarchy.",
|
|
6119
6173
|
"properties": {
|
|
6120
6174
|
"axis": {
|
|
6121
6175
|
"additionalProperties": {
|
|
@@ -6150,7 +6204,7 @@
|
|
|
6150
6204
|
"additionalProperties": {
|
|
6151
6205
|
"$ref": "#/definitions/ViewSpec"
|
|
6152
6206
|
},
|
|
6153
|
-
"description": "Templates that can be reused within the view specification by importing them with the template key.",
|
|
6207
|
+
"description": "[Templates](https://genomespy.app/docs/grammar/import/#repeating-with-named-templates) that can be reused within the view specification by importing them with the template key.",
|
|
6154
6208
|
"type": "object"
|
|
6155
6209
|
},
|
|
6156
6210
|
"title": {
|
|
@@ -6161,9 +6215,11 @@
|
|
|
6161
6215
|
{
|
|
6162
6216
|
"$ref": "#/definitions/Title"
|
|
6163
6217
|
}
|
|
6164
|
-
]
|
|
6218
|
+
],
|
|
6219
|
+
"description": "View title. N.B.: Currently, GenomeSpy doesn't do bound calculation, and you need to manually specify proper padding for the view to ensure that the title is visible."
|
|
6165
6220
|
},
|
|
6166
6221
|
"transform": {
|
|
6222
|
+
"description": "An array of [transformations](https://genomespy.app/docs/grammar/transform/) applied to the data before visual encoding.",
|
|
6167
6223
|
"items": {
|
|
6168
6224
|
"$ref": "#/definitions/TransformParams"
|
|
6169
6225
|
},
|
|
@@ -6182,7 +6238,7 @@
|
|
|
6182
6238
|
"type": "string"
|
|
6183
6239
|
}
|
|
6184
6240
|
],
|
|
6185
|
-
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
6241
|
+
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
6186
6242
|
},
|
|
6187
6243
|
"viewportWidth": {
|
|
6188
6244
|
"anyOf": [
|
|
@@ -6197,10 +6253,10 @@
|
|
|
6197
6253
|
"type": "string"
|
|
6198
6254
|
}
|
|
6199
6255
|
],
|
|
6200
|
-
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
6256
|
+
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
6201
6257
|
},
|
|
6202
6258
|
"visible": {
|
|
6203
|
-
"description": "
|
|
6259
|
+
"description": "The default visibility of the view. An invisible view is removed from the layout and not rendered. For context, see [toggleable view visibility](https://genomespy.app/docs/sample-collections/visualizing/#toggleable-view-visibility).\n\n**Default:** `true`",
|
|
6204
6260
|
"type": "boolean"
|
|
6205
6261
|
},
|
|
6206
6262
|
"width": {
|
|
@@ -6219,7 +6275,7 @@
|
|
|
6219
6275
|
"type": "string"
|
|
6220
6276
|
}
|
|
6221
6277
|
],
|
|
6222
|
-
"description": "Width of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
6278
|
+
"description": "Width of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default:** `\"container\"`"
|
|
6223
6279
|
}
|
|
6224
6280
|
},
|
|
6225
6281
|
"required": [
|
|
@@ -6239,15 +6295,16 @@
|
|
|
6239
6295
|
"type": "string"
|
|
6240
6296
|
},
|
|
6241
6297
|
"baseUrl": {
|
|
6242
|
-
"description": "
|
|
6298
|
+
"description": "The base URL for relative URL data sources and URL [imports](https://genomespy.app/docs/grammar/import/#importing-from-a-url). The base URLs are inherited in the view hierarchy unless overridden with this property. By default, the top-level view's base URL equals to the visualization specification's base URL.",
|
|
6243
6299
|
"type": "string"
|
|
6244
6300
|
},
|
|
6245
6301
|
"configurableVisibility": {
|
|
6246
|
-
"description": "Is the visibility configurable interactively from the App. Configurability requires that the view has an explicitly specified name that is *unique* in within the view
|
|
6302
|
+
"description": "Is the visibility configurable interactively from the [GenomeSpy App](https://genomespy.app/docs/sample-collections/). Configurability requires that the view has an explicitly specified name that is *unique* in within the view hierarchy.\n\n**Default:** `false` for children of `layer`, `true` for others.",
|
|
6247
6303
|
"type": "boolean"
|
|
6248
6304
|
},
|
|
6249
6305
|
"data": {
|
|
6250
|
-
"$ref": "#/definitions/Data"
|
|
6306
|
+
"$ref": "#/definitions/Data",
|
|
6307
|
+
"description": "Specifies a [data source](https://genomespy.app/docs/grammar/data/). If omitted, the data source is inherited from the parent view."
|
|
6251
6308
|
},
|
|
6252
6309
|
"datasets": {
|
|
6253
6310
|
"additionalProperties": {
|
|
@@ -6269,10 +6326,11 @@
|
|
|
6269
6326
|
"type": "array"
|
|
6270
6327
|
}
|
|
6271
6328
|
],
|
|
6272
|
-
"description": "A description of the view.
|
|
6329
|
+
"description": "A description of the view. Can be used for documentation. The description of the top-level view is shown in the toolbar of the [GenomeSpy App](https://genomespy.app/docs/sample-collections/)."
|
|
6273
6330
|
},
|
|
6274
6331
|
"encoding": {
|
|
6275
|
-
"$ref": "#/definitions/Encoding"
|
|
6332
|
+
"$ref": "#/definitions/Encoding",
|
|
6333
|
+
"description": "Specifies how data are [encoded](https://genomespy.app/docs/grammar/mark/#encoding) using the visual channels."
|
|
6276
6334
|
},
|
|
6277
6335
|
"genome": {
|
|
6278
6336
|
"$ref": "#/definitions/GenomeConfig"
|
|
@@ -6293,21 +6351,18 @@
|
|
|
6293
6351
|
"type": "string"
|
|
6294
6352
|
}
|
|
6295
6353
|
],
|
|
6296
|
-
"description": "Height of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
6354
|
+
"description": "Height of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default value:** `\"container\"`"
|
|
6297
6355
|
},
|
|
6298
6356
|
"name": {
|
|
6357
|
+
"description": "An internal name that can be used for referring the view. For referencing purposes, the name should be unique within the view hierarchy.",
|
|
6299
6358
|
"type": "string"
|
|
6300
6359
|
},
|
|
6301
|
-
"opacity": {
|
|
6302
|
-
"$ref": "#/definitions/ViewOpacityDef",
|
|
6303
|
-
"description": "Opacity of the view and all its children.\n\n**Default:** `1.0`"
|
|
6304
|
-
},
|
|
6305
6360
|
"padding": {
|
|
6306
6361
|
"$ref": "#/definitions/PaddingConfig",
|
|
6307
|
-
"description": "Padding
|
|
6362
|
+
"description": "Padding applied to the view. Accepts either a number representing pixels or an object specifying separate paddings for each edge.\n\nExamples:\n- `padding: 10`\n- `padding: { top: 10, right: 20, bottom: 10, left: 20 }`\n\n**Default value:** `0`"
|
|
6308
6363
|
},
|
|
6309
6364
|
"params": {
|
|
6310
|
-
"description": "Dynamic variables that parameterize a visualization.",
|
|
6365
|
+
"description": "Dynamic variables that [parameterize](https://genomespy.app/docs/grammar/parameters/) a visualization.",
|
|
6311
6366
|
"items": {
|
|
6312
6367
|
"$ref": "#/definitions/Parameter"
|
|
6313
6368
|
},
|
|
@@ -6315,6 +6370,7 @@
|
|
|
6315
6370
|
},
|
|
6316
6371
|
"resolve": {
|
|
6317
6372
|
"additionalProperties": false,
|
|
6373
|
+
"description": "Specifies how scales and axes are [resolved](https://genomespy.app/docs/grammar/composition/#scale-and-axis-resolution) in the view hierarchy.",
|
|
6318
6374
|
"properties": {
|
|
6319
6375
|
"axis": {
|
|
6320
6376
|
"additionalProperties": {
|
|
@@ -6363,7 +6419,7 @@
|
|
|
6363
6419
|
"additionalProperties": {
|
|
6364
6420
|
"$ref": "#/definitions/ViewSpec"
|
|
6365
6421
|
},
|
|
6366
|
-
"description": "Templates that can be reused within the view specification by importing them with the template key.",
|
|
6422
|
+
"description": "[Templates](https://genomespy.app/docs/grammar/import/#repeating-with-named-templates) that can be reused within the view specification by importing them with the template key.",
|
|
6367
6423
|
"type": "object"
|
|
6368
6424
|
},
|
|
6369
6425
|
"title": {
|
|
@@ -6374,9 +6430,11 @@
|
|
|
6374
6430
|
{
|
|
6375
6431
|
"$ref": "#/definitions/Title"
|
|
6376
6432
|
}
|
|
6377
|
-
]
|
|
6433
|
+
],
|
|
6434
|
+
"description": "View title. N.B.: Currently, GenomeSpy doesn't do bound calculation, and you need to manually specify proper padding for the view to ensure that the title is visible."
|
|
6378
6435
|
},
|
|
6379
6436
|
"transform": {
|
|
6437
|
+
"description": "An array of [transformations](https://genomespy.app/docs/grammar/transform/) applied to the data before visual encoding.",
|
|
6380
6438
|
"items": {
|
|
6381
6439
|
"$ref": "#/definitions/TransformParams"
|
|
6382
6440
|
},
|
|
@@ -6399,7 +6457,7 @@
|
|
|
6399
6457
|
"type": "string"
|
|
6400
6458
|
}
|
|
6401
6459
|
],
|
|
6402
|
-
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
6460
|
+
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
6403
6461
|
},
|
|
6404
6462
|
"viewportWidth": {
|
|
6405
6463
|
"anyOf": [
|
|
@@ -6414,10 +6472,10 @@
|
|
|
6414
6472
|
"type": "string"
|
|
6415
6473
|
}
|
|
6416
6474
|
],
|
|
6417
|
-
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
6475
|
+
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
6418
6476
|
},
|
|
6419
6477
|
"visible": {
|
|
6420
|
-
"description": "
|
|
6478
|
+
"description": "The default visibility of the view. An invisible view is removed from the layout and not rendered. For context, see [toggleable view visibility](https://genomespy.app/docs/sample-collections/visualizing/#toggleable-view-visibility).\n\n**Default:** `true`",
|
|
6421
6479
|
"type": "boolean"
|
|
6422
6480
|
},
|
|
6423
6481
|
"width": {
|
|
@@ -6436,7 +6494,7 @@
|
|
|
6436
6494
|
"type": "string"
|
|
6437
6495
|
}
|
|
6438
6496
|
],
|
|
6439
|
-
"description": "Width of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
6497
|
+
"description": "Width of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default:** `\"container\"`"
|
|
6440
6498
|
}
|
|
6441
6499
|
},
|
|
6442
6500
|
"required": [
|
|
@@ -6470,7 +6528,8 @@
|
|
|
6470
6528
|
{
|
|
6471
6529
|
"$ref": "#/definitions/ExprRef"
|
|
6472
6530
|
}
|
|
6473
|
-
]
|
|
6531
|
+
],
|
|
6532
|
+
"description": "Color of the mark. Affects either `fill` or `stroke`, depending on the `filled` property."
|
|
6474
6533
|
},
|
|
6475
6534
|
"minBufferSize": {
|
|
6476
6535
|
"description": "Minimum size for WebGL buffers (number of data items). Allows for using `bufferSubData()` to update graphics.\n\nThis property is intended for internal use.",
|
|
@@ -6495,7 +6554,8 @@
|
|
|
6495
6554
|
{
|
|
6496
6555
|
"$ref": "#/definitions/ExprRef"
|
|
6497
6556
|
}
|
|
6498
|
-
]
|
|
6557
|
+
],
|
|
6558
|
+
"description": "Opacity of the mark. Affects `fillOpacity` or `strokeOpacity`, depending on the `filled` property."
|
|
6499
6559
|
},
|
|
6500
6560
|
"size": {
|
|
6501
6561
|
"anyOf": [
|
|
@@ -6541,7 +6601,7 @@
|
|
|
6541
6601
|
},
|
|
6542
6602
|
"tooltip": {
|
|
6543
6603
|
"$ref": "#/definitions/Tooltip",
|
|
6544
|
-
"description": "Tooltip handler. If `null`, no tooltip is shown."
|
|
6604
|
+
"description": "Tooltip handler. If `null`, no tooltip is shown. If string, specifies the [tooltip handler](https://genomespy.app/docs/api/#custom-tooltip-handlers) to use."
|
|
6545
6605
|
},
|
|
6546
6606
|
"type": {
|
|
6547
6607
|
"const": "rule",
|
|
@@ -6555,7 +6615,8 @@
|
|
|
6555
6615
|
{
|
|
6556
6616
|
"$ref": "#/definitions/ExprRef"
|
|
6557
6617
|
}
|
|
6558
|
-
]
|
|
6618
|
+
],
|
|
6619
|
+
"description": "Position on the x axis."
|
|
6559
6620
|
},
|
|
6560
6621
|
"x2": {
|
|
6561
6622
|
"anyOf": [
|
|
@@ -6565,7 +6626,8 @@
|
|
|
6565
6626
|
{
|
|
6566
6627
|
"$ref": "#/definitions/ExprRef"
|
|
6567
6628
|
}
|
|
6568
|
-
]
|
|
6629
|
+
],
|
|
6630
|
+
"description": "The secondary position on the x axis."
|
|
6569
6631
|
},
|
|
6570
6632
|
"xOffset": {
|
|
6571
6633
|
"description": "Offsets of the `x` and `x2` coordinates in pixels. The offset is applied after the viewport scaling and translation.\n\n**Default value:** `0`",
|
|
@@ -6579,7 +6641,8 @@
|
|
|
6579
6641
|
{
|
|
6580
6642
|
"$ref": "#/definitions/ExprRef"
|
|
6581
6643
|
}
|
|
6582
|
-
]
|
|
6644
|
+
],
|
|
6645
|
+
"description": "Position on the y axis."
|
|
6583
6646
|
},
|
|
6584
6647
|
"y2": {
|
|
6585
6648
|
"anyOf": [
|
|
@@ -6589,7 +6652,8 @@
|
|
|
6589
6652
|
{
|
|
6590
6653
|
"$ref": "#/definitions/ExprRef"
|
|
6591
6654
|
}
|
|
6592
|
-
]
|
|
6655
|
+
],
|
|
6656
|
+
"description": "The secondary position on the y axis."
|
|
6593
6657
|
},
|
|
6594
6658
|
"yOffset": {
|
|
6595
6659
|
"description": "Offsets of the `y` and `y2` coordinates in pixels. The offset is applied after the viewport scaling and translation.\n\n**Default value:** `0`",
|
|
@@ -6726,15 +6790,16 @@
|
|
|
6726
6790
|
"description": "A view specification for a SampleView. This is only functional in the GenomeSpy app.",
|
|
6727
6791
|
"properties": {
|
|
6728
6792
|
"baseUrl": {
|
|
6729
|
-
"description": "
|
|
6793
|
+
"description": "The base URL for relative URL data sources and URL [imports](https://genomespy.app/docs/grammar/import/#importing-from-a-url). The base URLs are inherited in the view hierarchy unless overridden with this property. By default, the top-level view's base URL equals to the visualization specification's base URL.",
|
|
6730
6794
|
"type": "string"
|
|
6731
6795
|
},
|
|
6732
6796
|
"configurableVisibility": {
|
|
6733
|
-
"description": "Is the visibility configurable interactively from the App. Configurability requires that the view has an explicitly specified name that is *unique* in within the view
|
|
6797
|
+
"description": "Is the visibility configurable interactively from the [GenomeSpy App](https://genomespy.app/docs/sample-collections/). Configurability requires that the view has an explicitly specified name that is *unique* in within the view hierarchy.\n\n**Default:** `false` for children of `layer`, `true` for others.",
|
|
6734
6798
|
"type": "boolean"
|
|
6735
6799
|
},
|
|
6736
6800
|
"data": {
|
|
6737
|
-
"$ref": "#/definitions/Data"
|
|
6801
|
+
"$ref": "#/definitions/Data",
|
|
6802
|
+
"description": "Specifies a [data source](https://genomespy.app/docs/grammar/data/). If omitted, the data source is inherited from the parent view."
|
|
6738
6803
|
},
|
|
6739
6804
|
"description": {
|
|
6740
6805
|
"anyOf": [
|
|
@@ -6748,10 +6813,11 @@
|
|
|
6748
6813
|
"type": "array"
|
|
6749
6814
|
}
|
|
6750
6815
|
],
|
|
6751
|
-
"description": "A description of the view.
|
|
6816
|
+
"description": "A description of the view. Can be used for documentation. The description of the top-level view is shown in the toolbar of the [GenomeSpy App](https://genomespy.app/docs/sample-collections/)."
|
|
6752
6817
|
},
|
|
6753
6818
|
"encoding": {
|
|
6754
|
-
"$ref": "#/definitions/Encoding"
|
|
6819
|
+
"$ref": "#/definitions/Encoding",
|
|
6820
|
+
"description": "Specifies how data are [encoded](https://genomespy.app/docs/grammar/mark/#encoding) using the visual channels."
|
|
6755
6821
|
},
|
|
6756
6822
|
"height": {
|
|
6757
6823
|
"anyOf": [
|
|
@@ -6769,21 +6835,18 @@
|
|
|
6769
6835
|
"type": "string"
|
|
6770
6836
|
}
|
|
6771
6837
|
],
|
|
6772
|
-
"description": "Height of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
6838
|
+
"description": "Height of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default value:** `\"container\"`"
|
|
6773
6839
|
},
|
|
6774
6840
|
"name": {
|
|
6841
|
+
"description": "An internal name that can be used for referring the view. For referencing purposes, the name should be unique within the view hierarchy.",
|
|
6775
6842
|
"type": "string"
|
|
6776
6843
|
},
|
|
6777
|
-
"opacity": {
|
|
6778
|
-
"$ref": "#/definitions/ViewOpacityDef",
|
|
6779
|
-
"description": "Opacity of the view and all its children.\n\n**Default:** `1.0`"
|
|
6780
|
-
},
|
|
6781
6844
|
"padding": {
|
|
6782
6845
|
"$ref": "#/definitions/PaddingConfig",
|
|
6783
|
-
"description": "Padding
|
|
6846
|
+
"description": "Padding applied to the view. Accepts either a number representing pixels or an object specifying separate paddings for each edge.\n\nExamples:\n- `padding: 10`\n- `padding: { top: 10, right: 20, bottom: 10, left: 20 }`\n\n**Default value:** `0`"
|
|
6784
6847
|
},
|
|
6785
6848
|
"params": {
|
|
6786
|
-
"description": "Dynamic variables that parameterize a visualization.",
|
|
6849
|
+
"description": "Dynamic variables that [parameterize](https://genomespy.app/docs/grammar/parameters/) a visualization.",
|
|
6787
6850
|
"items": {
|
|
6788
6851
|
"$ref": "#/definitions/Parameter"
|
|
6789
6852
|
},
|
|
@@ -6791,6 +6854,7 @@
|
|
|
6791
6854
|
},
|
|
6792
6855
|
"resolve": {
|
|
6793
6856
|
"additionalProperties": false,
|
|
6857
|
+
"description": "Specifies how scales and axes are [resolved](https://genomespy.app/docs/grammar/composition/#scale-and-axis-resolution) in the view hierarchy.",
|
|
6794
6858
|
"properties": {
|
|
6795
6859
|
"axis": {
|
|
6796
6860
|
"additionalProperties": {
|
|
@@ -6839,7 +6903,7 @@
|
|
|
6839
6903
|
"additionalProperties": {
|
|
6840
6904
|
"$ref": "#/definitions/ViewSpec"
|
|
6841
6905
|
},
|
|
6842
|
-
"description": "Templates that can be reused within the view specification by importing them with the template key.",
|
|
6906
|
+
"description": "[Templates](https://genomespy.app/docs/grammar/import/#repeating-with-named-templates) that can be reused within the view specification by importing them with the template key.",
|
|
6843
6907
|
"type": "object"
|
|
6844
6908
|
},
|
|
6845
6909
|
"title": {
|
|
@@ -6850,9 +6914,11 @@
|
|
|
6850
6914
|
{
|
|
6851
6915
|
"$ref": "#/definitions/Title"
|
|
6852
6916
|
}
|
|
6853
|
-
]
|
|
6917
|
+
],
|
|
6918
|
+
"description": "View title. N.B.: Currently, GenomeSpy doesn't do bound calculation, and you need to manually specify proper padding for the view to ensure that the title is visible."
|
|
6854
6919
|
},
|
|
6855
6920
|
"transform": {
|
|
6921
|
+
"description": "An array of [transformations](https://genomespy.app/docs/grammar/transform/) applied to the data before visual encoding.",
|
|
6856
6922
|
"items": {
|
|
6857
6923
|
"$ref": "#/definitions/TransformParams"
|
|
6858
6924
|
},
|
|
@@ -6875,7 +6941,7 @@
|
|
|
6875
6941
|
"type": "string"
|
|
6876
6942
|
}
|
|
6877
6943
|
],
|
|
6878
|
-
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
6944
|
+
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
6879
6945
|
},
|
|
6880
6946
|
"viewportWidth": {
|
|
6881
6947
|
"anyOf": [
|
|
@@ -6890,10 +6956,10 @@
|
|
|
6890
6956
|
"type": "string"
|
|
6891
6957
|
}
|
|
6892
6958
|
],
|
|
6893
|
-
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
6959
|
+
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
6894
6960
|
},
|
|
6895
6961
|
"visible": {
|
|
6896
|
-
"description": "
|
|
6962
|
+
"description": "The default visibility of the view. An invisible view is removed from the layout and not rendered. For context, see [toggleable view visibility](https://genomespy.app/docs/sample-collections/visualizing/#toggleable-view-visibility).\n\n**Default:** `true`",
|
|
6897
6963
|
"type": "boolean"
|
|
6898
6964
|
},
|
|
6899
6965
|
"width": {
|
|
@@ -6912,7 +6978,7 @@
|
|
|
6912
6978
|
"type": "string"
|
|
6913
6979
|
}
|
|
6914
6980
|
],
|
|
6915
|
-
"description": "Width of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
6981
|
+
"description": "Width of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default:** `\"container\"`"
|
|
6916
6982
|
}
|
|
6917
6983
|
},
|
|
6918
6984
|
"required": [
|
|
@@ -7395,7 +7461,7 @@
|
|
|
7395
7461
|
"additionalProperties": false,
|
|
7396
7462
|
"properties": {
|
|
7397
7463
|
"grow": {
|
|
7398
|
-
"description": "Share of the remaining space",
|
|
7464
|
+
"description": "Share of the remaining space. See [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.",
|
|
7399
7465
|
"type": "number"
|
|
7400
7466
|
},
|
|
7401
7467
|
"px": {
|
|
@@ -7625,7 +7691,8 @@
|
|
|
7625
7691
|
{
|
|
7626
7692
|
"$ref": "#/definitions/ExprRef"
|
|
7627
7693
|
}
|
|
7628
|
-
]
|
|
7694
|
+
],
|
|
7695
|
+
"description": "Color of the mark. Affects either `fill` or `stroke`, depending on the `filled` property."
|
|
7629
7696
|
},
|
|
7630
7697
|
"dx": {
|
|
7631
7698
|
"description": "The horizontal offset between the text and its anchor point, in pixels. Applied after the rotation by `angle`.",
|
|
@@ -7703,7 +7770,8 @@
|
|
|
7703
7770
|
{
|
|
7704
7771
|
"$ref": "#/definitions/ExprRef"
|
|
7705
7772
|
}
|
|
7706
|
-
]
|
|
7773
|
+
],
|
|
7774
|
+
"description": "Opacity of the mark. Affects `fillOpacity` or `strokeOpacity`, depending on the `filled` property."
|
|
7707
7775
|
},
|
|
7708
7776
|
"paddingX": {
|
|
7709
7777
|
"anyOf": [
|
|
@@ -7762,7 +7830,7 @@
|
|
|
7762
7830
|
},
|
|
7763
7831
|
"tooltip": {
|
|
7764
7832
|
"$ref": "#/definitions/Tooltip",
|
|
7765
|
-
"description": "Tooltip handler. If `null`, no tooltip is shown."
|
|
7833
|
+
"description": "Tooltip handler. If `null`, no tooltip is shown. If string, specifies the [tooltip handler](https://genomespy.app/docs/api/#custom-tooltip-handlers) to use."
|
|
7766
7834
|
},
|
|
7767
7835
|
"type": {
|
|
7768
7836
|
"const": "text",
|
|
@@ -7800,7 +7868,8 @@
|
|
|
7800
7868
|
{
|
|
7801
7869
|
"$ref": "#/definitions/ExprRef"
|
|
7802
7870
|
}
|
|
7803
|
-
]
|
|
7871
|
+
],
|
|
7872
|
+
"description": "Position on the x axis."
|
|
7804
7873
|
},
|
|
7805
7874
|
"x2": {
|
|
7806
7875
|
"anyOf": [
|
|
@@ -7810,7 +7879,8 @@
|
|
|
7810
7879
|
{
|
|
7811
7880
|
"$ref": "#/definitions/ExprRef"
|
|
7812
7881
|
}
|
|
7813
|
-
]
|
|
7882
|
+
],
|
|
7883
|
+
"description": "The secondary position on the x axis."
|
|
7814
7884
|
},
|
|
7815
7885
|
"xOffset": {
|
|
7816
7886
|
"description": "Offsets of the `x` and `x2` coordinates in pixels. The offset is applied after the viewport scaling and translation.\n\n**Default value:** `0`",
|
|
@@ -7824,7 +7894,8 @@
|
|
|
7824
7894
|
{
|
|
7825
7895
|
"$ref": "#/definitions/ExprRef"
|
|
7826
7896
|
}
|
|
7827
|
-
]
|
|
7897
|
+
],
|
|
7898
|
+
"description": "Position on the y axis."
|
|
7828
7899
|
},
|
|
7829
7900
|
"y2": {
|
|
7830
7901
|
"anyOf": [
|
|
@@ -7834,7 +7905,8 @@
|
|
|
7834
7905
|
{
|
|
7835
7906
|
"$ref": "#/definitions/ExprRef"
|
|
7836
7907
|
}
|
|
7837
|
-
]
|
|
7908
|
+
],
|
|
7909
|
+
"description": "The secondary position on the y axis."
|
|
7838
7910
|
},
|
|
7839
7911
|
"yOffset": {
|
|
7840
7912
|
"description": "Offsets of the `y` and `y2` coordinates in pixels. The offset is applied after the viewport scaling and translation.\n\n**Default value:** `0`",
|
|
@@ -8072,6 +8144,7 @@
|
|
|
8072
8144
|
"additionalProperties": false,
|
|
8073
8145
|
"properties": {
|
|
8074
8146
|
"aggregateSamples": {
|
|
8147
|
+
"description": "Specifies views that [aggregate](https://genomespy.app/docs/sample-collections/visualizing/#aggregation) multiple samples within the GenomeSpy App.",
|
|
8075
8148
|
"items": {
|
|
8076
8149
|
"anyOf": [
|
|
8077
8150
|
{
|
|
@@ -8085,15 +8158,16 @@
|
|
|
8085
8158
|
"type": "array"
|
|
8086
8159
|
},
|
|
8087
8160
|
"baseUrl": {
|
|
8088
|
-
"description": "
|
|
8161
|
+
"description": "The base URL for relative URL data sources and URL [imports](https://genomespy.app/docs/grammar/import/#importing-from-a-url). The base URLs are inherited in the view hierarchy unless overridden with this property. By default, the top-level view's base URL equals to the visualization specification's base URL.",
|
|
8089
8162
|
"type": "string"
|
|
8090
8163
|
},
|
|
8091
8164
|
"configurableVisibility": {
|
|
8092
|
-
"description": "Is the visibility configurable interactively from the App. Configurability requires that the view has an explicitly specified name that is *unique* in within the view
|
|
8165
|
+
"description": "Is the visibility configurable interactively from the [GenomeSpy App](https://genomespy.app/docs/sample-collections/). Configurability requires that the view has an explicitly specified name that is *unique* in within the view hierarchy.\n\n**Default:** `false` for children of `layer`, `true` for others.",
|
|
8093
8166
|
"type": "boolean"
|
|
8094
8167
|
},
|
|
8095
8168
|
"data": {
|
|
8096
|
-
"$ref": "#/definitions/Data"
|
|
8169
|
+
"$ref": "#/definitions/Data",
|
|
8170
|
+
"description": "Specifies a [data source](https://genomespy.app/docs/grammar/data/). If omitted, the data source is inherited from the parent view."
|
|
8097
8171
|
},
|
|
8098
8172
|
"description": {
|
|
8099
8173
|
"anyOf": [
|
|
@@ -8107,10 +8181,11 @@
|
|
|
8107
8181
|
"type": "array"
|
|
8108
8182
|
}
|
|
8109
8183
|
],
|
|
8110
|
-
"description": "A description of the view.
|
|
8184
|
+
"description": "A description of the view. Can be used for documentation. The description of the top-level view is shown in the toolbar of the [GenomeSpy App](https://genomespy.app/docs/sample-collections/)."
|
|
8111
8185
|
},
|
|
8112
8186
|
"encoding": {
|
|
8113
|
-
"$ref": "#/definitions/Encoding"
|
|
8187
|
+
"$ref": "#/definitions/Encoding",
|
|
8188
|
+
"description": "Specifies how data are [encoded](https://genomespy.app/docs/grammar/mark/#encoding) using the visual channels."
|
|
8114
8189
|
},
|
|
8115
8190
|
"height": {
|
|
8116
8191
|
"anyOf": [
|
|
@@ -8128,7 +8203,7 @@
|
|
|
8128
8203
|
"type": "string"
|
|
8129
8204
|
}
|
|
8130
8205
|
],
|
|
8131
|
-
"description": "Height of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
8206
|
+
"description": "Height of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default value:** `\"container\"`"
|
|
8132
8207
|
},
|
|
8133
8208
|
"mark": {
|
|
8134
8209
|
"anyOf": [
|
|
@@ -8138,21 +8213,23 @@
|
|
|
8138
8213
|
{
|
|
8139
8214
|
"$ref": "#/definitions/MarkProps"
|
|
8140
8215
|
}
|
|
8141
|
-
]
|
|
8216
|
+
],
|
|
8217
|
+
"description": "The graphical mark presenting the data objects."
|
|
8142
8218
|
},
|
|
8143
8219
|
"name": {
|
|
8220
|
+
"description": "An internal name that can be used for referring the view. For referencing purposes, the name should be unique within the view hierarchy.",
|
|
8144
8221
|
"type": "string"
|
|
8145
8222
|
},
|
|
8146
8223
|
"opacity": {
|
|
8147
8224
|
"$ref": "#/definitions/ViewOpacityDef",
|
|
8148
|
-
"description": "Opacity of the view and all its children.\n\n**Default:** `1.0`"
|
|
8225
|
+
"description": "Opacity of the view and all its children. Allows implementing semantic zooming where the layers are faded in and out as the user zooms in and out.\n\nTODO: Write proper documentation with examples.\n\n**Default:** `1.0`"
|
|
8149
8226
|
},
|
|
8150
8227
|
"padding": {
|
|
8151
8228
|
"$ref": "#/definitions/PaddingConfig",
|
|
8152
|
-
"description": "Padding
|
|
8229
|
+
"description": "Padding applied to the view. Accepts either a number representing pixels or an object specifying separate paddings for each edge.\n\nExamples:\n- `padding: 10`\n- `padding: { top: 10, right: 20, bottom: 10, left: 20 }`\n\n**Default value:** `0`"
|
|
8153
8230
|
},
|
|
8154
8231
|
"params": {
|
|
8155
|
-
"description": "Dynamic variables that parameterize a visualization.",
|
|
8232
|
+
"description": "Dynamic variables that [parameterize](https://genomespy.app/docs/grammar/parameters/) a visualization.",
|
|
8156
8233
|
"items": {
|
|
8157
8234
|
"$ref": "#/definitions/Parameter"
|
|
8158
8235
|
},
|
|
@@ -8160,6 +8237,7 @@
|
|
|
8160
8237
|
},
|
|
8161
8238
|
"resolve": {
|
|
8162
8239
|
"additionalProperties": false,
|
|
8240
|
+
"description": "Specifies how scales and axes are [resolved](https://genomespy.app/docs/grammar/composition/#scale-and-axis-resolution) in the view hierarchy.",
|
|
8163
8241
|
"properties": {
|
|
8164
8242
|
"axis": {
|
|
8165
8243
|
"additionalProperties": {
|
|
@@ -8190,7 +8268,7 @@
|
|
|
8190
8268
|
"additionalProperties": {
|
|
8191
8269
|
"$ref": "#/definitions/ViewSpec"
|
|
8192
8270
|
},
|
|
8193
|
-
"description": "Templates that can be reused within the view specification by importing them with the template key.",
|
|
8271
|
+
"description": "[Templates](https://genomespy.app/docs/grammar/import/#repeating-with-named-templates) that can be reused within the view specification by importing them with the template key.",
|
|
8194
8272
|
"type": "object"
|
|
8195
8273
|
},
|
|
8196
8274
|
"title": {
|
|
@@ -8201,16 +8279,19 @@
|
|
|
8201
8279
|
{
|
|
8202
8280
|
"$ref": "#/definitions/Title"
|
|
8203
8281
|
}
|
|
8204
|
-
]
|
|
8282
|
+
],
|
|
8283
|
+
"description": "View title. N.B.: Currently, GenomeSpy doesn't do bound calculation, and you need to manually specify proper padding for the view to ensure that the title is visible."
|
|
8205
8284
|
},
|
|
8206
8285
|
"transform": {
|
|
8286
|
+
"description": "An array of [transformations](https://genomespy.app/docs/grammar/transform/) applied to the data before visual encoding.",
|
|
8207
8287
|
"items": {
|
|
8208
8288
|
"$ref": "#/definitions/TransformParams"
|
|
8209
8289
|
},
|
|
8210
8290
|
"type": "array"
|
|
8211
8291
|
},
|
|
8212
8292
|
"view": {
|
|
8213
|
-
"$ref": "#/definitions/ViewBackground"
|
|
8293
|
+
"$ref": "#/definitions/ViewBackground",
|
|
8294
|
+
"description": "The background of the view, including fill, stroke, and stroke width."
|
|
8214
8295
|
},
|
|
8215
8296
|
"viewportHeight": {
|
|
8216
8297
|
"anyOf": [
|
|
@@ -8225,7 +8306,7 @@
|
|
|
8225
8306
|
"type": "string"
|
|
8226
8307
|
}
|
|
8227
8308
|
],
|
|
8228
|
-
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
8309
|
+
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
8229
8310
|
},
|
|
8230
8311
|
"viewportWidth": {
|
|
8231
8312
|
"anyOf": [
|
|
@@ -8240,10 +8321,10 @@
|
|
|
8240
8321
|
"type": "string"
|
|
8241
8322
|
}
|
|
8242
8323
|
],
|
|
8243
|
-
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
8324
|
+
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
8244
8325
|
},
|
|
8245
8326
|
"visible": {
|
|
8246
|
-
"description": "
|
|
8327
|
+
"description": "The default visibility of the view. An invisible view is removed from the layout and not rendered. For context, see [toggleable view visibility](https://genomespy.app/docs/sample-collections/visualizing/#toggleable-view-visibility).\n\n**Default:** `true`",
|
|
8247
8328
|
"type": "boolean"
|
|
8248
8329
|
},
|
|
8249
8330
|
"width": {
|
|
@@ -8262,7 +8343,7 @@
|
|
|
8262
8343
|
"type": "string"
|
|
8263
8344
|
}
|
|
8264
8345
|
],
|
|
8265
|
-
"description": "Width of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
8346
|
+
"description": "Width of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default:** `\"container\"`"
|
|
8266
8347
|
}
|
|
8267
8348
|
},
|
|
8268
8349
|
"required": [
|
|
@@ -8321,15 +8402,16 @@
|
|
|
8321
8402
|
"additionalProperties": false,
|
|
8322
8403
|
"properties": {
|
|
8323
8404
|
"baseUrl": {
|
|
8324
|
-
"description": "
|
|
8405
|
+
"description": "The base URL for relative URL data sources and URL [imports](https://genomespy.app/docs/grammar/import/#importing-from-a-url). The base URLs are inherited in the view hierarchy unless overridden with this property. By default, the top-level view's base URL equals to the visualization specification's base URL.",
|
|
8325
8406
|
"type": "string"
|
|
8326
8407
|
},
|
|
8327
8408
|
"configurableVisibility": {
|
|
8328
|
-
"description": "Is the visibility configurable interactively from the App. Configurability requires that the view has an explicitly specified name that is *unique* in within the view
|
|
8409
|
+
"description": "Is the visibility configurable interactively from the [GenomeSpy App](https://genomespy.app/docs/sample-collections/). Configurability requires that the view has an explicitly specified name that is *unique* in within the view hierarchy.\n\n**Default:** `false` for children of `layer`, `true` for others.",
|
|
8329
8410
|
"type": "boolean"
|
|
8330
8411
|
},
|
|
8331
8412
|
"data": {
|
|
8332
|
-
"$ref": "#/definitions/Data"
|
|
8413
|
+
"$ref": "#/definitions/Data",
|
|
8414
|
+
"description": "Specifies a [data source](https://genomespy.app/docs/grammar/data/). If omitted, the data source is inherited from the parent view."
|
|
8333
8415
|
},
|
|
8334
8416
|
"description": {
|
|
8335
8417
|
"anyOf": [
|
|
@@ -8343,10 +8425,11 @@
|
|
|
8343
8425
|
"type": "array"
|
|
8344
8426
|
}
|
|
8345
8427
|
],
|
|
8346
|
-
"description": "A description of the view.
|
|
8428
|
+
"description": "A description of the view. Can be used for documentation. The description of the top-level view is shown in the toolbar of the [GenomeSpy App](https://genomespy.app/docs/sample-collections/)."
|
|
8347
8429
|
},
|
|
8348
8430
|
"encoding": {
|
|
8349
|
-
"$ref": "#/definitions/Encoding"
|
|
8431
|
+
"$ref": "#/definitions/Encoding",
|
|
8432
|
+
"description": "Specifies how data are [encoded](https://genomespy.app/docs/grammar/mark/#encoding) using the visual channels."
|
|
8350
8433
|
},
|
|
8351
8434
|
"height": {
|
|
8352
8435
|
"anyOf": [
|
|
@@ -8364,21 +8447,18 @@
|
|
|
8364
8447
|
"type": "string"
|
|
8365
8448
|
}
|
|
8366
8449
|
],
|
|
8367
|
-
"description": "Height of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
8450
|
+
"description": "Height of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default value:** `\"container\"`"
|
|
8368
8451
|
},
|
|
8369
8452
|
"name": {
|
|
8453
|
+
"description": "An internal name that can be used for referring the view. For referencing purposes, the name should be unique within the view hierarchy.",
|
|
8370
8454
|
"type": "string"
|
|
8371
8455
|
},
|
|
8372
|
-
"opacity": {
|
|
8373
|
-
"$ref": "#/definitions/ViewOpacityDef",
|
|
8374
|
-
"description": "Opacity of the view and all its children.\n\n**Default:** `1.0`"
|
|
8375
|
-
},
|
|
8376
8456
|
"padding": {
|
|
8377
8457
|
"$ref": "#/definitions/PaddingConfig",
|
|
8378
|
-
"description": "Padding
|
|
8458
|
+
"description": "Padding applied to the view. Accepts either a number representing pixels or an object specifying separate paddings for each edge.\n\nExamples:\n- `padding: 10`\n- `padding: { top: 10, right: 20, bottom: 10, left: 20 }`\n\n**Default value:** `0`"
|
|
8379
8459
|
},
|
|
8380
8460
|
"params": {
|
|
8381
|
-
"description": "Dynamic variables that parameterize a visualization.",
|
|
8461
|
+
"description": "Dynamic variables that [parameterize](https://genomespy.app/docs/grammar/parameters/) a visualization.",
|
|
8382
8462
|
"items": {
|
|
8383
8463
|
"$ref": "#/definitions/Parameter"
|
|
8384
8464
|
},
|
|
@@ -8386,6 +8466,7 @@
|
|
|
8386
8466
|
},
|
|
8387
8467
|
"resolve": {
|
|
8388
8468
|
"additionalProperties": false,
|
|
8469
|
+
"description": "Specifies how scales and axes are [resolved](https://genomespy.app/docs/grammar/composition/#scale-and-axis-resolution) in the view hierarchy.",
|
|
8389
8470
|
"properties": {
|
|
8390
8471
|
"axis": {
|
|
8391
8472
|
"additionalProperties": {
|
|
@@ -8420,7 +8501,7 @@
|
|
|
8420
8501
|
"additionalProperties": {
|
|
8421
8502
|
"$ref": "#/definitions/ViewSpec"
|
|
8422
8503
|
},
|
|
8423
|
-
"description": "Templates that can be reused within the view specification by importing them with the template key.",
|
|
8504
|
+
"description": "[Templates](https://genomespy.app/docs/grammar/import/#repeating-with-named-templates) that can be reused within the view specification by importing them with the template key.",
|
|
8424
8505
|
"type": "object"
|
|
8425
8506
|
},
|
|
8426
8507
|
"title": {
|
|
@@ -8431,9 +8512,11 @@
|
|
|
8431
8512
|
{
|
|
8432
8513
|
"$ref": "#/definitions/Title"
|
|
8433
8514
|
}
|
|
8434
|
-
]
|
|
8515
|
+
],
|
|
8516
|
+
"description": "View title. N.B.: Currently, GenomeSpy doesn't do bound calculation, and you need to manually specify proper padding for the view to ensure that the title is visible."
|
|
8435
8517
|
},
|
|
8436
8518
|
"transform": {
|
|
8519
|
+
"description": "An array of [transformations](https://genomespy.app/docs/grammar/transform/) applied to the data before visual encoding.",
|
|
8437
8520
|
"items": {
|
|
8438
8521
|
"$ref": "#/definitions/TransformParams"
|
|
8439
8522
|
},
|
|
@@ -8466,7 +8549,7 @@
|
|
|
8466
8549
|
"type": "string"
|
|
8467
8550
|
}
|
|
8468
8551
|
],
|
|
8469
|
-
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
8552
|
+
"description": "Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `height`)"
|
|
8470
8553
|
},
|
|
8471
8554
|
"viewportWidth": {
|
|
8472
8555
|
"anyOf": [
|
|
@@ -8481,10 +8564,10 @@
|
|
|
8481
8564
|
"type": "string"
|
|
8482
8565
|
}
|
|
8483
8566
|
],
|
|
8484
|
-
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with scrollbars. This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
8567
|
+
"description": "Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with [scrollbars](https://genomespy.app/docs/grammar/composition/concat/#scrollable-viewports). This property implicitly enables clipping.\n\n**Default:** `null` (same as `width`)"
|
|
8485
8568
|
},
|
|
8486
8569
|
"visible": {
|
|
8487
|
-
"description": "
|
|
8570
|
+
"description": "The default visibility of the view. An invisible view is removed from the layout and not rendered. For context, see [toggleable view visibility](https://genomespy.app/docs/sample-collections/visualizing/#toggleable-view-visibility).\n\n**Default:** `true`",
|
|
8488
8571
|
"type": "boolean"
|
|
8489
8572
|
},
|
|
8490
8573
|
"width": {
|
|
@@ -8503,7 +8586,7 @@
|
|
|
8503
8586
|
"type": "string"
|
|
8504
8587
|
}
|
|
8505
8588
|
],
|
|
8506
|
-
"description": "Width of the view. If a number, it is interpreted as pixels.\n\n**Default:** `\"container\"`"
|
|
8589
|
+
"description": "Width of the view. If a number, it is interpreted as pixels. Check [child sizing](https://genomespy.app/docs/grammar/composition/concat/#child-sizing) for details.\n\n**Default:** `\"container\"`"
|
|
8507
8590
|
}
|
|
8508
8591
|
},
|
|
8509
8592
|
"required": [
|
|
@@ -8671,7 +8754,7 @@
|
|
|
8671
8754
|
"$ref": "#/definitions/ExprRef"
|
|
8672
8755
|
}
|
|
8673
8756
|
],
|
|
8674
|
-
"description": "The fill color"
|
|
8757
|
+
"description": "The fill color."
|
|
8675
8758
|
},
|
|
8676
8759
|
"fillOpacity": {
|
|
8677
8760
|
"anyOf": [
|
|
@@ -8682,7 +8765,7 @@
|
|
|
8682
8765
|
"$ref": "#/definitions/ExprRef"
|
|
8683
8766
|
}
|
|
8684
8767
|
],
|
|
8685
|
-
"description": "The fill opacity. Value between
|
|
8768
|
+
"description": "The fill opacity. Value between `0` and `1`."
|
|
8686
8769
|
},
|
|
8687
8770
|
"stroke": {
|
|
8688
8771
|
"anyOf": [
|
|
@@ -8704,7 +8787,7 @@
|
|
|
8704
8787
|
"$ref": "#/definitions/ExprRef"
|
|
8705
8788
|
}
|
|
8706
8789
|
],
|
|
8707
|
-
"description": "The stroke opacity. Value between
|
|
8790
|
+
"description": "The stroke opacity. Value between `0` and `1`."
|
|
8708
8791
|
},
|
|
8709
8792
|
"strokeWidth": {
|
|
8710
8793
|
"description": "The stroke width in pixels.",
|