npm - @loveluthien/carta-frontend - Versions diffs - 6.0.0-dev - Mend

@loveluthien/carta-frontend 6.0.0-dev

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.

Files changed (148) hide show

package/schemas/layout_schema_2.json ADDED Viewed

@@ -0,0 +1,440 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Layout",
+    "description": "Schema for CARTA Layout (Version 2)",
+    "$id": "https://cartavis.org/schemas/layout_schema_2.json",
+    "type": "object",
+    "definitions": {
+        "percentage-value": {
+            "description": "Describes a percentage value from 0 to 100",
+            "type": "number",
+            "minimum": 0,
+            "maximum": 100
+        },
+        "plot-type": {
+            "description": "Describes a plot type",
+            "enum": ["Steps", "Lines", "Points"]
+        },
+        "line-width": {
+            "description": "Describes a plot line width",
+            "type": "number",
+            "minimum": 0.5,
+            "maximum": 10.0
+        },
+        "point-size": {
+            "description": "Describes a plot point size",
+            "type": "number",
+            "minimum": 0.5,
+            "maximum": 10.0
+        },
+        "opacity": {
+            "description": "Describes an opacity value between zero and one",
+            "type": "number",
+            "minimum": 0,
+            "maximum": 1
+        },
+        "spatial-coord": {
+            "description": "Spatial coordinate",
+            "type": "string",
+            "enum": ["x", "Ix", "Qx", "Ux", "Vx", "y", "Iy", "Qy", "Uy", "Vy"]
+        },
+        "spectral-coord": {
+            "description": "Spectral coordinate",
+            "type": "string",
+            "enum": ["z", "Iz", "Qz", "Uz", "Vz"]
+        },
+        "basic-widget": {
+            "type": "object",
+            "description": "Widgets that have no associated settings",
+            "required": ["type", "id"],
+            "properties": {
+                "type": {
+                    "const": "component"
+                },
+                "id": {
+                    "type": "string",
+                    "enum": ["floating-settings", "layer-list", "log", "animator", "region-list", "image-view", "stats", "spectral-line-query", "cursor-info", "catalog-overlay", "catalog-plot"]
+                },
+                "width": {
+                    "$ref": "#/definitions/percentage-value"
+                },
+                "height": {
+                    "$ref": "#/definitions/percentage-value"
+                }
+            }
+        },
+        "spectral-profiler": {
+            "type": "object",
+            "description": "Spectral profiler widgets",
+            "required": ["type", "id"],
+            "properties": {
+                "type": {
+                    "const": "component"
+                },
+                "id": {
+                    "const": "spectral-profiler"
+                },
+                "widgetSettings": {
+                    "type": "object",
+                    "properties": {
+                        "coordinate": {
+                            "$ref": "#/definitions/spectral-coord"
+                        },
+                        "primaryLineColor": {
+                            "type": "string"
+                        },
+                        "lineWidth": {
+                            "$ref": "#/definitions/line-width"
+                        },
+                        "linePlotPointSize": {
+                            "$ref": "#/definitions/point-size"
+                        },
+                        "meanRmsVisible": {
+                            "type": "boolean"
+                        },
+                        "plotType": {
+                            "$ref": "#/definitions/plot-type"
+                        },
+                        "minXVal": {
+                            "type": "number"
+                        },
+                        "maxXVal": {
+                            "type": "number"
+                        },
+                        "minYVal": {
+                            "type": "number"
+                        },
+                        "maxYVal": {
+                            "type": "number"
+                        }
+                    }
+                },
+                "width": {
+                    "$ref": "#/definitions/percentage-value"
+                },
+                "height": {
+                    "$ref": "#/definitions/percentage-value"
+                }
+            }
+        },
+        "spatial-profiler": {
+            "type": "object",
+            "description": "Spatial profiler widgets",
+            "required": ["type", "id"],
+            "properties": {
+                "type": {
+                    "const": "component"
+                },
+                "id": {
+                    "const": "spatial-profiler"
+                },
+                "widgetSettings": {
+                    "type": "object",
+                    "properties": {
+                        "coordinate": {
+                            "$ref": "#/definitions/spatial-coord"
+                        },
+                        "primaryLineColor": {
+                            "type": "string"
+                        },
+                        "lineWidth": {
+                            "$ref": "#/definitions/line-width"
+                        },
+                        "linePlotPointSize": {
+                            "$ref": "#/definitions/point-size"
+                        },
+                        "wcsAxisVisible": {
+                            "type": "boolean"
+                        },
+                        "meanRmsVisible": {
+                            "type": "boolean"
+                        },
+                        "plotType": {
+                            "$ref": "#/definitions/plot-type"
+                        },
+                        "minXVal": {
+                            "type": "number"
+                        },
+                        "maxXVal": {
+                            "type": "number"
+                        },
+                        "minYVal": {
+                            "type": "number"
+                        },
+                        "maxYVal": {
+                            "type": "number"
+                        }
+                    }
+                },
+                "coord": {
+                    "description": "Legacy V1 entry (replaced by widgetSettings.coordinate",
+                    "$ref": "#/definitions/spatial-coord"
+                },
+                "width": {
+                    "$ref": "#/definitions/percentage-value"
+                },
+                "height": {
+                    "$ref": "#/definitions/percentage-value"
+                }
+            }
+        },
+        "render-config": {
+            "type": "object",
+            "description": "Render config widgets",
+            "required": ["type", "id"],
+            "properties": {
+                "type": {
+                    "const": "component"
+                },
+                "id": {
+                    "const": "render-config"
+                },
+                "widgetSettings": {
+                    "type": "object",
+                    "properties": {
+                        "primaryLineColor": {
+                            "type": "string"
+                        },
+                        "lineWidth": {
+                            "$ref": "#/definitions/line-width"
+                        },
+                        "linePlotPointSize": {
+                            "$ref": "#/definitions/point-size"
+                        },
+                        "logScaleY": {
+                            "type": "boolean"
+                        },
+                        "markerTextVisible": {
+                            "type": "boolean"
+                        },
+                        "meanRmsVisible": {
+                            "type": "boolean"
+                        },
+                        "plotType": {
+                            "$ref": "#/definitions/plot-type"
+                        },
+                        "minXVal": {
+                            "type": "number"
+                        },
+                        "maxXVal": {
+                            "type": "number"
+                        },
+                        "minYVal": {
+                            "type": "number"
+                        },
+                        "maxYVal": {
+                            "type": "number"
+                        }
+                    }
+                },
+                "width": {
+                    "$ref": "#/definitions/percentage-value"
+                },
+                "height": {
+                    "$ref": "#/definitions/percentage-value"
+                }
+            }
+        },
+        "histogram": {
+            "type": "object",
+            "description": "Histogram widgets",
+            "required": ["type", "id"],
+            "properties": {
+                "type": {
+                    "const": "component"
+                },
+                "id": {
+                    "const": "histogram"
+                },
+                "widgetSettings": {
+                    "type": "object",
+                    "properties": {
+                        "primaryLineColor": {
+                            "type": "string"
+                        },
+                        "lineWidth": {
+                            "$ref": "#/definitions/line-width"
+                        },
+                        "linePlotPointSize": {
+                            "$ref": "#/definitions/point-size"
+                        },
+                        "logScaleY": {
+                            "type": "boolean"
+                        },
+                        "plotType": {
+                            "$ref": "#/definitions/plot-type"
+                        },
+                        "minXVal": {
+                            "type": "number"
+                        },
+                        "maxXVal": {
+                            "type": "number"
+                        },
+                        "minYVal": {
+                            "type": "number"
+                        },
+                        "maxYVal": {
+                            "type": "number"
+                        }
+                    }
+                },
+                "width": {
+                    "$ref": "#/definitions/percentage-value"
+                },
+                "height": {
+                    "$ref": "#/definitions/percentage-value"
+                }
+            }
+        },
+        "stokes": {
+            "type": "object",
+            "description": "Stokes analysis widgets",
+            "required": ["type", "id"],
+            "properties": {
+                "type": {
+                    "const": "component"
+                },
+                "id": {
+                    "const": "stokes"
+                },
+                "widgetSettings": {
+                    "type": "object",
+                    "properties": {
+                        "primaryLineColor": {
+                            "type": "string"
+                        },
+                        "secondaryLineColor": {
+                            "type": "string"
+                        },
+                        "lineWidth": {
+                            "$ref": "#/definitions/line-width"
+                        },
+                        "linePlotPointSize": {
+                            "$ref": "#/definitions/point-size"
+                        },
+                        "plotType": {
+                            "$ref": "#/definitions/plot-type"
+                        },
+                        "colorMap": {
+                            "type": "string"
+                        },
+                        "scatterPlotPointSize": {
+                            "$ref": "#/definitions/point-size"
+                        },
+                        "pointTransparency": {
+                            "$ref": "#/definitions/opacity"
+                        },
+                        "equalAxes": {
+                            "type": "boolean"
+                        }
+                    }
+                },
+                "width": {
+                    "$ref": "#/definitions/percentage-value"
+                },
+                "height": {
+                    "$ref": "#/definitions/percentage-value"
+                }
+            }
+        },
+        "carta-widget": {
+            "description": "A CARTA widget",
+            "oneOf": [
+                {
+                    "$ref": "#/definitions/basic-widget"
+                },
+                {
+                    "$ref": "#/definitions/spectral-profiler"
+                },
+                {
+                    "$ref": "#/definitions/spatial-profiler"
+                },
+                {
+                    "$ref": "#/definitions/render-config"
+                },
+                {
+                    "$ref": "#/definitions/histogram"
+                },
+                {
+                    "$ref": "#/definitions/stokes"
+                }
+            ]
+        },
+        "gl-container": {
+            "description": "A GoldenLayout container",
+            "type": "object",
+            "required": ["type", "content"],
+            "additionalProperties": false,
+            "properties": {
+                "type": {
+                    "enum": ["row", "column", "stack"]
+                },
+                "content": {
+                    "type": "array",
+                    "minItems": 1,
+                    "items": {
+                        "oneOf": [
+                            {
+                                "$ref": "#/definitions/gl-container"
+                            },
+                            {
+                                "$ref": "#/definitions/carta-widget"
+                            }
+                        ]
+                    }
+                },
+                "width": {
+                    "$ref": "#/definitions/percentage-value"
+                },
+                "height": {
+                    "$ref": "#/definitions/percentage-value"
+                },
+                "activeItemIndex": {
+                    "type": "integer",
+                    "minimum": 0
+                }
+            }
+        }
+    },
+    "required": ["layoutVersion", "docked", "floating"],
+    "properties": {
+        "layoutVersion": {
+            "description": "The version of the layout contained",
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 2
+        },
+        "docked": {
+            "description": "GoldenLayout widget hierarchy",
+            "$ref": "#/definitions/gl-container"
+        },
+        "floating": {
+            "description": "List of floating widgets",
+            "type": "array",
+            "items": {
+                "allOf": [
+                    {
+                        "$ref": "#/definitions/carta-widget"
+                    },
+                    {
+                        "type": "object",
+                        "properties": {
+                            "defaultX": {
+                                "type": "number"
+                            },
+                            "defaultY": {
+                                "type": "number"
+                            },
+                            "defaultWidth": {
+                                "type": "number"
+                            },
+                            "defaultHeight": {
+                                "type": "number"
+                            }
+                        }
+                    }
+                ]
+            }
+        }
+    }
+}

package/schemas/preference_backend_schema_1.json ADDED Viewed

@@ -0,0 +1,81 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Backend preferences",
+    "description": "Schema for CARTA backend preferences (Version 1)",
+    "$id": "https://cartavis.org/schemas/preference_backend_schema_1.json",
+    "required": [],
+    "properties": {
+        "verbosity": {
+            "type": "integer",
+            "enum": [0, 1, 2, 3, 4, 5],
+            "default": 4
+        },
+        "no_log": {
+            "type": "boolean",
+            "default": true
+        },
+        "log_performance": {
+            "type": "boolean",
+            "default": false
+        },
+        "log_protocol_messages": {
+            "type": "boolean",
+            "default": false
+        },
+        "no_http": {
+            "type": "boolean",
+            "default": false
+        },
+        "no_browser": {
+            "type": "boolean",
+            "default": false
+        },
+        "browser": {
+            "type": "string",
+            "default": ""
+        },
+        "host": {
+            "type": "string",
+            "minLength": 1,
+            "default": "0.0.0.0"
+        },
+        "port": {
+            "type": ["integer", "array"],
+            "default": 3002
+        },
+        "grpc_port": {
+            "type": "integer",
+            "default": -1
+        },
+        "omp_threads": {
+            "type": "integer",
+            "default": -1
+        },
+        "top_level_folder": {
+            "type": "string",
+            "minLength": 1,
+            "default": "/"
+        },
+        "frontend_folder": {
+            "type": "string",
+            "minLength": 1,
+            "default": ""
+        },
+        "exit_timeout": {
+            "type": "integer",
+            "default": -1
+        },
+        "initial_timeout": {
+            "type": "integer",
+            "default": -1
+        },
+        "idle_timeout": {
+            "type": "integer",
+            "default": -1
+        },
+        "read_only_mode": {
+            "type": "boolean",
+            "default": false
+        }
+    }
+}

package/schemas/preference_backend_schema_2.json ADDED Viewed

@@ -0,0 +1,118 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Backend preferences",
+    "description": "Schema for CARTA backend preferences (Version 2)",
+    "$id": "https://cartavis.org/schemas/preference_backend_schema_2.json",
+    "type": "object",
+    "properties": {
+        "backendConfigVersion": {
+            "description": "The version of this backend configuration",
+            "type": "string",
+            "default": "2.0"
+        },
+        "verbosity": {
+            "type": "integer",
+            "enum": [0, 1, 2, 3, 4, 5],
+            "default": 4
+        },
+        "no_log": {
+            "type": "boolean",
+            "default": true
+        },
+        "log_performance": {
+            "type": "boolean",
+            "default": false
+        },
+        "log_protocol_messages": {
+            "type": "boolean",
+            "default": false
+        },
+        "no_frontend": {
+            "type": "boolean",
+            "default": false
+        },
+        "no_database": {
+            "type": "boolean",
+            "default": false
+        },
+        "no_http": {
+            "type": "boolean",
+            "default": false
+        },
+        "no_browser": {
+            "type": "boolean",
+            "default": false
+        },
+        "browser": {
+            "type": "string",
+            "default": ""
+        },
+        "host": {
+            "type": "string",
+            "minLength": 1,
+            "default": "0.0.0.0"
+        },
+        "port": {
+            "anyOf": [
+                {
+                    "type": "integer"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "integer"
+                    }
+                }
+            ],
+            "default": 3002
+        },
+        "omp_threads": {
+            "type": "integer",
+            "default": -1
+        },
+        "top_level_folder": {
+            "type": "string",
+            "minLength": 1,
+            "default": "/"
+        },
+        "frontend_folder": {
+            "type": "string",
+            "minLength": 1,
+            "default": ""
+        },
+        "exit_timeout": {
+            "type": "integer",
+            "default": -1
+        },
+        "initial_timeout": {
+            "type": "integer",
+            "default": -1
+        },
+        "idle_timeout": {
+            "type": "integer",
+            "default": -1
+        },
+        "read_only_mode": {
+            "type": "boolean",
+            "default": false
+        },
+        "starting_folder": {
+            "type": "string",
+            "minLength": 1,
+            "default": ""
+        },
+        "event_thread_count": {
+            "type": "integer",
+            "default": -1
+        },
+        "enable_scripting": {
+            "type": "boolean",
+            "default": false
+        },
+        "http_url_prefix": {
+            "type": "string",
+            "minLength": 1,
+            "default": ""
+        }
+    }
+}