refactor(core): make header mark use underscore (#1075)

* feat: update schema with _header * fix: update uses of header mark * refactor: update comment
gosling-lang · Jun 12, 2024 · eedb53b · eedb53b
1 parent 17fd085
commit eedb53b
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 7 deletions.
diff --git a/src/compiler/bounding-box.ts b/src/compiler/bounding-box.ts
@@ -385,7 +385,7 @@ export function getNumOfYAxes(tracks: Track[]): number {
 const getTextTrack = (size: Size, title?: string, subtitle?: string) => {
     return JSON.parse(
         JSON.stringify({
-            mark: 'header',
+            mark: '_header',
             width: size.width,
             height: size.height,
             title,

diff --git a/src/compiler/gosling-to-higlass.ts b/src/compiler/gosling-to-higlass.ts
@@ -282,7 +282,7 @@ export function goslingToHiGlass(
         });
 
         hgModel.validateSpec(true);
-    } else if (firstResolvedSpec.mark === 'header') {
+    } else if (firstResolvedSpec.mark === '_header') {
         // `text` tracks are used to show title and subtitle of the views
         hgModel.addDefaultView(`${trackId}-title`).setLayout(layout);
         if (typeof firstResolvedSpec.title === 'string') {

diff --git a/src/gosling-schema/gosling.schema.json b/src/gosling-schema/gosling.schema.json
@@ -3758,7 +3758,7 @@
         "triangleRight",
         "triangleBottom",
         "brush",
-        "header"
+        "_header"
       ],
       "type": "string"
     },

diff --git a/src/gosling-schema/gosling.schema.ts b/src/gosling-schema/gosling.schema.ts
@@ -272,9 +272,8 @@ export type Mark =
     | 'triangleRight'
     | 'triangleBottom'
     | 'brush'
-    // TODO: perhaps need to make this invisible to users
-    // being used to show title/subtitle internally
-    | 'header';
+    // The _header mark is used internally for text tracks
+    | '_header';
 
 /* ----------------------------- API & MOUSE EVENTS ----------------------------- */
 interface CommonEventData {

diff --git a/src/gosling-schema/template.schema.json b/src/gosling-schema/template.schema.json
@@ -924,7 +924,7 @@
         "triangleRight",
         "triangleBottom",
         "brush",
-        "header"
+        "_header"
       ],
       "type": "string"
     },