rename variables to clearly state layout dependency

GMOD · Mar 6, 2024 · 8355237 · 8355237
1 parent 1d571b7
commit 8355237
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 30 deletions.
diff --git a/plugins/linear-genome-view/src/BaseLinearDisplay/models/BaseLinearDisplayModel.tsx b/plugins/linear-genome-view/src/BaseLinearDisplay/models/BaseLinearDisplayModel.tsx
@@ -105,7 +105,7 @@ function stateModelFactory() {
        * #getter
        * array of all block heights
        */
-      get blockHeights() {
+      get layoutBlockHeights() {
         try {
           const { blockDefinitions, blockState } = self
           return blockDefinitions.map(block => {
@@ -121,8 +121,8 @@ function stateModelFactory() {
        * #getter
        * returns true if all blocks are defined
        */
-      get allBlocksRendered() {
-        return this.blockHeights.every(b => b !== undefined)
+      get allLayoutBlocksRendered() {
+        return this.layoutBlockHeights.every(b => b !== undefined)
       },
 
       /**

diff --git a/plugins/linear-genome-view/src/BaseLinearDisplay/models/TrackHeightMixin.tsx b/plugins/linear-genome-view/src/BaseLinearDisplay/models/TrackHeightMixin.tsx
@@ -49,22 +49,22 @@ export default function TrackHeightMixin() {
        * #getter
        * returns the value of the track height setting from the view model
        */
-      get trackHeightSetting() {
-        const { trackHeightSetting } = getContainingView(
+      get adjustTrackLayoutHeightSetting() {
+        const { adjustTrackLayoutHeightSetting } = getContainingView(
           self,
         ) as LinearGenomeViewModel
 
-        return trackHeightSetting
+        return adjustTrackLayoutHeightSetting
       },
       /**
        * #getter
        * the max height between the rendered blocks and the configured height
        */
-      get maxBlockHeight() {
+      get maxLayoutBlockHeight() {
         // @ts-expect-error
         const confHeight = getConf(self, 'height') as number
         // @ts-expect-error
-        return max(self.blockHeights, confHeight)
+        return max(self.layoutBlockHeights, confHeight)
       },
       /**
        * #getter
@@ -73,9 +73,9 @@ export default function TrackHeightMixin() {
       get layoutMaxHeight() {
         // @ts-expect-error
         const confHeight = getConf(self, 'height') as number
-        return this.trackHeightSetting === 'on'
-          ? this.maxBlockHeight
-          : this.trackHeightSetting === 'first_render'
+        return this.adjustTrackLayoutHeightSetting === 'on'
+          ? this.maxLayoutBlockHeight
+          : this.adjustTrackLayoutHeightSetting === 'first_render'
             ? max([self.firstRenderHeight], confHeight)
             : confHeight
       },
@@ -117,9 +117,12 @@ export default function TrackHeightMixin() {
           autorun(() => {
             const ready =
               // @ts-expect-error
-              self.allBlocksRendered && self.firstRenderHeight === 0
-            if (self.trackHeightSetting === 'first_render' && ready) {
-              self.setFirstRenderHeight(self.maxBlockHeight)
+              self.allLayoutBlocksRendered && self.firstRenderHeight === 0
+            if (
+              self.adjustTrackLayoutHeightSetting === 'first_render' &&
+              ready
+            ) {
+              self.setFirstRenderHeight(self.maxLayoutBlockHeight)
             }
           }),
         )

diff --git a/plugins/linear-genome-view/src/LinearGenomeView/model.ts b/plugins/linear-genome-view/src/LinearGenomeView/model.ts
@@ -242,9 +242,9 @@ export function stateModelFactory(pluginManager: PluginManager) {
          * #property
          * setting to auto-adjust the layout height of tracks
          */
-        adjustLayoutHeight: types.optional(
+        adjustTrackLayoutHeight: types.optional(
           types.string,
-          () => localStorageGetItem('lgv-adjustLayoutHeight') || 'off',
+          () => localStorageGetItem('lgv-adjustTrackLayoutHeight') || 'off',
         ),
 
         /**
@@ -292,12 +292,12 @@ export function stateModelFactory(pluginManager: PluginManager) {
       /**
        * #getter
        */
-      get trackHeightSetting() {
+      get adjustTrackLayoutHeightSetting() {
         const sessionSetting = getConf(getSession(self), [
           'LinearGenomeViewPlugin',
           'trackHeight',
         ])
-        return self.adjustLayoutHeight || sessionSetting
+        return self.adjustTrackLayoutHeight || sessionSetting
       },
       /**
        * #getter
@@ -818,9 +818,9 @@ export function stateModelFactory(pluginManager: PluginManager) {
       /**
        * #action
        */
-      setAdjustLayoutHeight(setting: 'on' | 'off' | 'first_render') {
-        localStorage.setItem('lgv-adjustLayoutHeight', setting)
-        self.adjustLayoutHeight = setting
+      setadjustTrackLayoutHeight(setting: 'on' | 'off' | 'first_render') {
+        localStorage.setItem('lgv-adjustTrackLayoutHeight', setting)
+        self.adjustTrackLayoutHeight = setting
       },
 
       /**
@@ -1215,20 +1215,20 @@ export function stateModelFactory(pluginManager: PluginManager) {
               {
                 label: 'Use default (from config)',
                 type: 'radio',
-                checked: self.trackHeightSetting === 'off',
-                onClick: () => self.setAdjustLayoutHeight('off'),
+                checked: self.adjustTrackLayoutHeightSetting === 'off',
+                onClick: () => self.setadjustTrackLayoutHeight('off'),
               },
               {
                 label: 'Auto-adjust to show all features on track',
                 type: 'radio',
-                checked: self.trackHeightSetting === 'on',
-                onClick: () => self.setAdjustLayoutHeight('on'),
+                checked: self.adjustTrackLayoutHeightSetting === 'on',
+                onClick: () => self.setadjustTrackLayoutHeight('on'),
               },
               {
                 label: 'Auto-adjust to show height of initial features',
                 type: 'radio',
-                checked: self.trackHeightSetting === 'first_render',
-                onClick: () => self.setAdjustLayoutHeight('first_render'),
+                checked: self.adjustTrackLayoutHeightSetting === 'first_render',
+                onClick: () => self.setadjustTrackLayoutHeight('first_render'),
               },
             ],
           },

diff --git a/plugins/linear-genome-view/src/index.ts b/plugins/linear-genome-view/src/index.ts
@@ -54,12 +54,12 @@ export default class LinearGenomeViewPlugin extends Plugin {
       ]),
     },
     /**
-     * #slot configuration.LinearGenomeViewPlugin.trackHeight
+     * #slot configuration.LinearGenomeViewPlugin.adjustTrackLayoutHeight
      */
-    trackHeight: {
+    adjustTrackLayoutHeight: {
       type: 'string',
       defaultValue: 'off',
-      model: types.enumeration('trackHeightOptions', [
+      model: types.enumeration('adjustTrackLayoutHeightOptions', [
         'off',
         'on',
         'first_render',