Variable: layoutSchema
const layoutSchema: object;
The layout-1 JSON Schema (schemas/layout.schema.json) as an object, for validators.
Type Declaration
$defs
readonly $defs: object;
$defs.edge
readonly edge: object;
$defs.edge.additionalProperties
readonly additionalProperties: false = false;
$defs.edge.description
readonly description: "Manual routing of one relationship edge." = "Manual routing of one relationship edge.";
$defs.edge.properties
readonly properties: object;
$defs.edge.properties.sourceSide
readonly sourceSide: object;
$defs.edge.properties.sourceSide.$ref
readonly $ref: "#/$defs/side" = "#/$defs/side";
$defs.edge.properties.targetSide
readonly targetSide: object;
$defs.edge.properties.targetSide.$ref
readonly $ref: "#/$defs/side" = "#/$defs/side";
$defs.edge.properties.waypoints
readonly waypoints: object;
$defs.edge.properties.waypoints.description
readonly description: "Intermediate bend points in diagram coordinates, from source to target." = "Intermediate bend points in diagram coordinates, from source to target.";
$defs.edge.properties.waypoints.items
readonly items: object;
$defs.edge.properties.waypoints.items.$ref
readonly $ref: "#/$defs/point" = "#/$defs/point";
$defs.edge.properties.waypoints.type
readonly type: "array" = "array";
$defs.edge.type
readonly type: "object" = "object";
$defs.edges
readonly edges: object;
$defs.edges.additionalProperties
readonly additionalProperties: object;
$defs.edges.additionalProperties.$ref
readonly $ref: "#/$defs/edge" = "#/$defs/edge";
$defs.edges.description
readonly description: "Edge routing keyed by the ref id from the relvista diagram model." = "Edge routing keyed by the ref id from the relvista diagram model.";
$defs.edges.propertyNames
readonly propertyNames: object;
$defs.edges.propertyNames.pattern
readonly pattern: "^ref:." = "^ref:.";
$defs.edges.type
readonly type: "object" = "object";
$defs.node
readonly node: object;
$defs.node.$ref
readonly $ref: "#/$defs/nodeFields" = "#/$defs/nodeFields";
$defs.node.description
readonly description: "Placement of one node in the default view. x/y is the top-left corner in diagram coordinates." = "Placement of one node in the default view. x/y is the top-left corner in diagram coordinates.";
$defs.node.required
readonly required: readonly ["x", "y"];
$defs.node.type
readonly type: "object" = "object";
$defs.nodeFields
readonly nodeFields: object;
$defs.nodeFields.additionalProperties
readonly additionalProperties: false = false;
$defs.nodeFields.properties
readonly properties: object;
$defs.nodeFields.properties.collapsed
readonly collapsed: object;
$defs.nodeFields.properties.collapsed.description
readonly description: "Show only the header (tables) or the title (groups)." = "Show only the header (tables) or the title (groups).";
$defs.nodeFields.properties.collapsed.type
readonly type: "boolean" = "boolean";
$defs.nodeFields.properties.h
readonly h: object;
$defs.nodeFields.properties.h.description
readonly description: "Height override. Omit to use the measured height." = "Height override. Omit to use the measured height.";
$defs.nodeFields.properties.h.exclusiveMinimum
readonly exclusiveMinimum: 0 = 0;
$defs.nodeFields.properties.h.type
readonly type: "number" = "number";
$defs.nodeFields.properties.pinned
readonly pinned: object;
$defs.nodeFields.properties.pinned.description
readonly description: "Auto-layout must not move this node." = "Auto-layout must not move this node.";
$defs.nodeFields.properties.pinned.type
readonly type: "boolean" = "boolean";
$defs.nodeFields.properties.w
readonly w: object;
$defs.nodeFields.properties.w.description
readonly description: "Width override. Omit to use the measured width." = "Width override. Omit to use the measured width.";
$defs.nodeFields.properties.w.exclusiveMinimum
readonly exclusiveMinimum: 0 = 0;
$defs.nodeFields.properties.w.type
readonly type: "number" = "number";
$defs.nodeFields.properties.x
readonly x: object;
$defs.nodeFields.properties.x.type
readonly type: "number" = "number";
$defs.nodeFields.properties.y
readonly y: object;
$defs.nodeFields.properties.y.type
readonly type: "number" = "number";
$defs.nodeFields.type
readonly type: "object" = "object";
$defs.nodeId
readonly nodeId: object;
$defs.nodeId.description
readonly description: "Stable node id: \"schema.table\" for tables (schema always explicit, \"public\" by default), \"note:<name>\" for sticky notes, \"group:<name>\" for table groups. A table-id segment that is empty, contains . \" \\ : , ( or ), or starts with < > - or ?, is double-quoted with \" and \\ backslash-escaped: a.\"b.c\"." = "Stable node id: \"schema.table\" for tables (schema always explicit, \"public\" by default), \"note:<name>\" for sticky notes, \"group:<name>\" for table groups. A table-id segment that is empty, contains . \" \\ : , ( or ), or starts with < > - or ?, is double-quoted with \" and \\ backslash-escaped: a.\"b.c\".";
$defs.nodeId.pattern
readonly pattern: "^(note:.+|group:.+|(?:[^.\"\\\\:,()<>?-][^.\"\\\\:,()]*|\"(?:[^\"\\\\]|\\\\.)*\")\\.(?:[^.\"\\\\:,()<>?-][^.\"\\\\:,()]*|\"(?:[^\"\\\\]|\\\\.)*\"))$" = "^(note:.+|group:.+|(?:[^.\"\\\\:,()<>?-][^.\"\\\\:,()]*|\"(?:[^\"\\\\]|\\\\.)*\")\\.(?:[^.\"\\\\:,()<>?-][^.\"\\\\:,()]*|\"(?:[^\"\\\\]|\\\\.)*\"))$";
$defs.nodeId.type
readonly type: "string" = "string";
$defs.nodeOverride
readonly nodeOverride: object;
$defs.nodeOverride.$ref
readonly $ref: "#/$defs/nodeFields" = "#/$defs/nodeFields";
$defs.nodeOverride.description
readonly description: "Node entry of a named view: only the fields that differ from the default view." = "Node entry of a named view: only the fields that differ from the default view.";
$defs.point
readonly point: object;
$defs.point.additionalProperties
readonly additionalProperties: false = false;
$defs.point.properties
readonly properties: object;
$defs.point.properties.x
readonly x: object;
$defs.point.properties.x.type
readonly type: "number" = "number";
$defs.point.properties.y
readonly y: object;
$defs.point.properties.y.type
readonly type: "number" = "number";
$defs.point.required
readonly required: readonly ["x", "y"];
$defs.point.type
readonly type: "object" = "object";
$defs.settings
readonly settings: object;
$defs.settings.additionalProperties
readonly additionalProperties: false = false;
$defs.settings.patternProperties
readonly patternProperties: object;
$defs.settings.patternProperties.^x-
readonly "^x-": object = {};
$defs.settings.properties
readonly properties: object;
$defs.settings.properties.detailLevel
readonly detailLevel: object;
$defs.settings.properties.detailLevel.description
readonly description: "Which columns tables show: all columns, key columns only, or table names only." = "Which columns tables show: all columns, key columns only, or table names only.";
$defs.settings.properties.detailLevel.enum
readonly enum: readonly ["all", "keys", "names"];
$defs.settings.properties.detailLevel.type
readonly type: "string" = "string";
$defs.settings.properties.theme
readonly theme: object;
$defs.settings.properties.theme.additionalProperties
readonly additionalProperties: false = false;
$defs.settings.properties.theme.description
readonly description: "Rendering hints. Viewers may ignore them." = "Rendering hints. Viewers may ignore them.";
$defs.settings.properties.theme.properties
readonly properties: object;
$defs.settings.properties.theme.properties.colorScheme
readonly colorScheme: object;
$defs.settings.properties.theme.properties.colorScheme.enum
readonly enum: readonly ["light", "dark", "auto"];
$defs.settings.properties.theme.properties.colorScheme.type
readonly type: "string" = "string";
$defs.settings.properties.theme.properties.edgeStyle
readonly edgeStyle: object;
$defs.settings.properties.theme.properties.edgeStyle.enum
readonly enum: readonly ["orthogonal", "curved", "straight"];
$defs.settings.properties.theme.properties.edgeStyle.type
readonly type: "string" = "string";
$defs.settings.properties.theme.properties.showGrid
readonly showGrid: object;
$defs.settings.properties.theme.properties.showGrid.type
readonly type: "boolean" = "boolean";
$defs.settings.properties.theme.type
readonly type: "object" = "object";
$defs.settings.type
readonly type: "object" = "object";
$defs.side
readonly side: object;
$defs.side.enum
readonly enum: readonly ["top", "right", "bottom", "left"];
$defs.side.type
readonly type: "string" = "string";
$defs.view
readonly view: object;
$defs.view.additionalProperties
readonly additionalProperties: false = false;
$defs.view.properties
readonly properties: object;
$defs.view.properties.edges
readonly edges: object;
$defs.view.properties.edges.$ref
readonly $ref: "#/$defs/edges" = "#/$defs/edges";
$defs.view.properties.nodes
readonly nodes: object;
$defs.view.properties.nodes.additionalProperties
readonly additionalProperties: object;
$defs.view.properties.nodes.additionalProperties.$ref
readonly $ref: "#/$defs/node" = "#/$defs/node";
$defs.view.properties.nodes.propertyNames
readonly propertyNames: object;
$defs.view.properties.nodes.propertyNames.$ref
readonly $ref: "#/$defs/nodeId" = "#/$defs/nodeId";
$defs.view.properties.nodes.type
readonly type: "object" = "object";
$defs.view.properties.viewport
readonly viewport: object;
$defs.view.properties.viewport.$ref
readonly $ref: "#/$defs/viewport" = "#/$defs/viewport";
$defs.view.required
readonly required: readonly ["nodes"];
$defs.view.type
readonly type: "object" = "object";
$defs.viewOverride
readonly viewOverride: object;
$defs.viewOverride.additionalProperties
readonly additionalProperties: false = false;
$defs.viewOverride.description
readonly description: "A named view: entries merge field by field over the default view." = "A named view: entries merge field by field over the default view.";
$defs.viewOverride.properties
readonly properties: object;
$defs.viewOverride.properties.edges
readonly edges: object;
$defs.viewOverride.properties.edges.$ref
readonly $ref: "#/$defs/edges" = "#/$defs/edges";
$defs.viewOverride.properties.nodes
readonly nodes: object;
$defs.viewOverride.properties.nodes.additionalProperties
readonly additionalProperties: object;
$defs.viewOverride.properties.nodes.additionalProperties.$ref
readonly $ref: "#/$defs/nodeOverride" = "#/$defs/nodeOverride";
$defs.viewOverride.properties.nodes.propertyNames
readonly propertyNames: object;
$defs.viewOverride.properties.nodes.propertyNames.$ref
readonly $ref: "#/$defs/nodeId" = "#/$defs/nodeId";
$defs.viewOverride.properties.nodes.type
readonly type: "object" = "object";
$defs.viewOverride.properties.viewport
readonly viewport: object;
$defs.viewOverride.properties.viewport.$ref
readonly $ref: "#/$defs/viewport" = "#/$defs/viewport";
$defs.viewOverride.required
readonly required: readonly ["nodes"];
$defs.viewOverride.type
readonly type: "object" = "object";
$defs.viewport
readonly viewport: object;
$defs.viewport.additionalProperties
readonly additionalProperties: false = false;
$defs.viewport.description
readonly description: "Camera: x/y is the diagram point at the top-left of the canvas." = "Camera: x/y is the diagram point at the top-left of the canvas.";
$defs.viewport.properties
readonly properties: object;
$defs.viewport.properties.x
readonly x: object;
$defs.viewport.properties.x.type
readonly type: "number" = "number";
$defs.viewport.properties.y
readonly y: object;
$defs.viewport.properties.y.type
readonly type: "number" = "number";
$defs.viewport.properties.zoom
readonly zoom: object;
$defs.viewport.properties.zoom.exclusiveMinimum
readonly exclusiveMinimum: 0 = 0;
$defs.viewport.properties.zoom.type
readonly type: "number" = "number";
$defs.viewport.required
readonly required: readonly ["x", "y", "zoom"];
$defs.viewport.type
readonly type: "object" = "object";
$id
readonly $id: "https://relvista.org/schemas/layout-1.json" = "https://relvista.org/schemas/layout-1.json";
$schema
readonly $schema: "https://json-schema.org/draft/2020-12/schema" = "https://json-schema.org/draft/2020-12/schema";
additionalProperties
readonly additionalProperties: false = false;
description
readonly description: "Sidecar file (schema.dbml.layout.json) holding everything DBML cannot store: node positions and sizes, per-view viewports, edge routing and display settings." = "Sidecar file (schema.dbml.layout.json) holding everything DBML cannot store: node positions and sizes, per-view viewports, edge routing and display settings.";
patternProperties
readonly patternProperties: object;
patternProperties.^x-
readonly "^x-": object;
patternProperties.^x-.description
readonly description: "Extension data for third-party tools. Preserved, never interpreted." = "Extension data for third-party tools. Preserved, never interpreted.";
properties
readonly properties: object;
properties.$schema
readonly $schema: object;
properties.$schema.description
readonly description: "URI of this JSON Schema, for editor tooling. Ignored by relvista." = "URI of this JSON Schema, for editor tooling. Ignored by relvista.";
properties.$schema.type
readonly type: "string" = "string";
properties.settings
readonly settings: object;
properties.settings.$ref
readonly $ref: "#/$defs/settings" = "#/$defs/settings";
properties.version
readonly version: object;
properties.version.const
readonly const: 1 = 1;
properties.version.description
readonly description: "Format version. Only 1 exists." = "Format version. Only 1 exists.";
properties.views
readonly views: object;
properties.views.additionalProperties
readonly additionalProperties: object;
properties.views.additionalProperties.$ref
readonly $ref: "#/$defs/viewOverride" = "#/$defs/viewOverride";
properties.views.description
readonly description: "Layouts keyed by view name. The key \"*\" is the default view; named views inherit from it and store only what differs." = "Layouts keyed by view name. The key \"*\" is the default view; named views inherit from it and store only what differs.";
properties.views.properties
readonly properties: object;
properties.views.properties.*
readonly "*": object;
properties.views.properties.*.$ref
readonly $ref: "#/$defs/view" = "#/$defs/view";
properties.views.propertyNames
readonly propertyNames: object;
properties.views.propertyNames.minLength
readonly minLength: 1 = 1;
properties.views.type
readonly type: "object" = "object";
required
readonly required: readonly ["version", "views"];
title
readonly title: "relvista layout file" = "relvista layout file";
type
readonly type: "object" = "object";