@abi-software/flatmapvuer 1.1.0-beta.3 → 1.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abi-software/flatmapvuer",
-  "version": "1.1.0-beta.3",
+  "version": "1.1.1",
   "license": "Apache-2.0",
   "files": [
     "dist/*",

package/src/App.vue

@@ -4,7 +4,7 @@
       placement="bottom"
       trigger="click"
       width="500"
-      class="popover"
+      popper-class="popover options-popover"
       :teleported="false"
     >
       <div class="options-container">
@@ -69,12 +69,27 @@
       @ready="FlatmapReady"
       :initial="initial"
       :helpMode="helpMode"
+      :helpModeDialog="useHelpModeDialog"
+      :helpModeActiveItem="helpModeActiveItem"
+      @help-mode-last-item="onHelpModeLastItem"
+      @shown-tooltip="onTooltipShown"
+      @shown-map-tooltip="onMapTooltipShown"
       :displayMinimap="true"
       :enableOpenMapUI="true"
       :flatmapAPI="flatmapAPI"
       :disableUI="disableUI"
       @open-pubmed-url="onOpenPubmedUrl"
       @pathway-selection-changed="onPathwaySelectionChanged"
+      @flatmapChanged="onFlatmapChanged"
+    />
+
+    <HelpModeDialog
+      v-if="helpMode && useHelpModeDialog"
+      ref="multiflatmapHelp"
+      :multiflatmapRef="multiflatmapRef"
+      :lastItem="helpModeLastItem"
+      @show-next="onHelpModeShowNext"
+      @finish-help-mode="onFinishHelpMode"
     />
   </div>
 </template>
@@ -84,6 +99,7 @@ import { shallowRef } from 'vue';
 import { Setting as ElIconSetting } from '@element-plus/icons-vue'
 /* eslint-disable no-alert, no-console */
 import MultiFlatmapVuer from './components/MultiFlatmapVuer.vue'
+import HelpModeDialog from './components/HelpModeDialog.vue';
 import {
   ElAutocomplete as Autocomplete,
   ElButton as Button,
@@ -102,6 +118,7 @@ export default {
     ElIconSetting,
     Popover,
     Row,
+    HelpModeDialog,
   },
   methods: {
     saveSettings: function () {
@@ -113,30 +130,30 @@ export default {
     },
     FlatmapSelected: function (resource) {
       if (resource.eventType === 'click') {
-        console.log('resource', resource)
+        if (this.consoleOn) console.log('resource', resource)
       }
     },
     onOpenPubmedUrl: function (url) {
-      console.log('open-pubmed-url', url);
+      if (this.consoleOn) console.log('open-pubmed-url', url);
     },
     onPathwaySelectionChanged: function (data) {
-      console.log('pathway-selection-changed', data);
+      if (this.consoleOn) console.log('pathway-selection-changed', data);
     },
     FlatmapReady: function (component) {
-      console.log(component)
+      if (this.consoleOn) console.log(component)
       let taxon = component.mapImp.describes
       let id = component.mapImp.addMarker('UBERON:0000948')
       window.flatmapImp = component.mapImp
       component.enablePanZoomEvents(true)
       //component.showPathwaysDrawer(false);
-      console.log(taxon, id)
+      if (this.consoleOn) console.log(taxon, id)
       //component.searchAndShowResult("heart");
     },
     panZoomcallback: function (payload) {
       this.payload = payload
     },
     openMap: function (map) {
-      console.log(map)
+      if (this.consoleOn) console.log(map)
     },
     fetchSuggestions: function (term, cb) {
       if (term === '') {
@@ -161,14 +178,42 @@ export default {
       }
     },
     search: function () {
-      console.log(this.searchText)
+      if (this.consoleOn) console.log(this.searchText)
       this.$refs.multi
         .getCurrentFlatmap()
         .searchAndShowResult(this.searchText, true)
     },
+    onFlatmapChanged: function () {
+      this.helpMode = false;
+    },
+    onHelpModeShowNext: function () {
+      this.helpModeActiveItem += 1;
+    },
+    onHelpModeLastItem: function (isLastItem) {
+      if (isLastItem) {
+        this.helpModeLastItem = true;
+      }
+    },
+    onFinishHelpMode: function () {
+      this.helpMode = false;
+      // reset help mode to default values
+      this.helpModeActiveItem = 0;
+      this.helpModeLastItem = false;
+    },
+    onTooltipShown: function () {
+      if (this.$refs.multi && this.$refs.multiflatmapHelp) {
+        this.$refs.multiflatmapHelp.toggleTooltipHighlight();
+      }
+    },
+    onMapTooltipShown: function () {
+      if (this.$refs.multi && this.$refs.multiflatmapHelp) {
+        this.$refs.multiflatmapHelp.toggleTooltipPinHighlight();
+      }
+    },
   },
   data: function () {
     return {
+      consoleOn: true,
       searchText: '',
       disableUI: false,
       minZoom: 4,
@@ -228,6 +273,10 @@ export default {
       displayCloseButton: false,
       initial: 'Rat',
       helpMode: false,
+      helpModeActiveItem: 0,
+      helpModeLastItem: false,
+      useHelpModeDialog: true,
+      multiflatmapRef: null,
       mapSettings: [],
       //flatmapAPI: "https://mapcore-demo.org/current/flatmap/v2/"
       //flatmapAPI: "https://mapcore-demo.org/devel/flatmap/v3/"
@@ -239,6 +288,16 @@ export default {
       ElIconSetting: shallowRef(ElIconSetting)
     }
   },
+  mounted: function () {
+    this.multiflatmapRef = this.$refs.multi;
+  },
+  watch: {
+    helpMode: function (newVal) {
+      if (!newVal) {
+        this.helpModeActiveItem = 0;
+      }
+    }
+  },
   components: {
     MultiFlatmapVuer,
   },
@@ -306,6 +365,8 @@ body {
 .options-button {
   z-index:100;
   position: absolute;
+  left: 50%;
+  transform: translateX(-50%);
 }
 
 .options-container {

package/src/components/ConnectionDialog.vue

@@ -1,43 +1,41 @@
 <template>
   <div class="dialog-container">
     <el-row>
-      <span class="dialog-title" v-if="inDrawing">Finalise drawing</span>
-      <span class="dialog-title" v-else>Visualise connection</span>
-      <el-row v-if="inDrawing">
-        <el-col :span="13">
-          <el-button type="primary" plain @click="$emit('confirmDrawn', true)">
-            Confirm
-          </el-button>
-        </el-col>
-        <el-col :span="11">
-          <el-button type="primary" plain @click="$emit('cancelDrawn', true)">
-            Cancel
+      <el-col>
+        <span class="dialog-title">Visualise connection</span>
+        <el-row v-if="inDrawing">
+          <span class="dialog-subtitle">Finalise drawing</span>
+          <el-button-group>
+            <el-button
+              type="primary"
+              plain
+              @click="$emit('confirmDrawn', true)"
+            >
+              Confirm
+            </el-button>
+            <el-button type="primary" plain @click="$emit('cancelDrawn', true)">
+              Cancel
+            </el-button>
+          </el-button-group>
+        </el-row>
+        <el-row v-else>
+          <el-button
+            type="primary"
+            plain
+            @click="$emit('dialogDisplay', false)"
+          >
+            Close
           </el-button>
-        </el-col>
-      </el-row>
-      <el-row v-else>
-        <el-button type="primary" plain @click="$emit('dialogDisplay', false)">
-          Close
-        </el-button>
-      </el-row>
+        </el-row>
+      </el-col>
     </el-row>
-    <el-row v-if="connection">
+    <el-row v-if="hasConnection">
       <el-col>
         <b><span>Related Features</span></b>
         <el-row v-for="(value, key) in connectionEntry" :key="key">
-          <el-col :span="20">
-            <el-card
-              :shadow="activeShadow(key)"
-              @click="handleTooltipOpen(key)"
-            >
-              <span>{{ capitalise(value.label) }}</span>
-            </el-card>
-          </el-col>
-          <el-col :span="4" v-if="key === tooltipId">
-            <el-icon>
-              <el-icon-circle-close @click="handleTooltipClose(key)" />
-            </el-icon>
-          </el-col>
+          <el-card :shadow="shadowDisplay(key)" @click="handleTooltip(key)">
+            <span>{{ capitalise(value.label) }}</span>
+          </el-card>
         </el-row>
       </el-col>
     </el-row>
@@ -46,14 +44,21 @@
 
 <script>
 /* eslint-disable no-alert, no-console */
-import { CircleClose as ElIconCircleClose } from "@element-plus/icons-vue";
-import { ElRow as Row, ElCol as Col, ElCard as Card } from "element-plus";
+import {
+  ElRow as Row,
+  ElCol as Col,
+  ElCard as Card,
+  ElButton as Button,
+  ElButtonGroup as ButtonGroup,
+} from "element-plus";
 
 export default {
   name: "ConnectionDialog",
   components: {
     Row,
     Col,
+    ButtonGroup,
+    Button,
     Card,
   },
   props: {
@@ -64,7 +69,7 @@ export default {
       type: Boolean,
       default: false,
     },
-    connection: {
+    hasConnection: {
       type: Boolean,
       default: false,
     },
@@ -74,28 +79,16 @@ export default {
       tooltipId: undefined,
     };
   },
-  watch: {
-    connection: function () {
-      this.tooltipId = undefined;
-    },
-  },
   methods: {
-    activeShadow: function (value) {
-      if (this.inDrawing && !Number(value)) return "never";
-      return "hover";
+    shadowDisplay: function (value) {
+      return this.tooltipId === value ? "always" : "hover";
     },
     capitalise: function (label) {
       return label[0].toUpperCase() + label.slice(1);
     },
-    handleTooltipOpen: function (value) {
-      this.tooltipId = value;
-      // temp solution, not allow to check drawn feature while drawing
-      if (this.inDrawing && !Number(value)) this.tooltipId = undefined;
-      this.$emit("showFeatureTooltip", this.tooltipId);
-    },
-    handleTooltipClose: function (value) {
-      this.tooltipId = undefined;
-      this.$emit("hideFeatureTooltip", value);
+    handleTooltip: function (value) {
+      this.tooltipId = this.tooltipId === value ? undefined : value;
+      this.$emit("featureTooltip", this.tooltipId);
     },
   },
 };
@@ -122,11 +115,18 @@ export default {
   color: rgb(131, 0, 191);
 }
 
-.el-icon {
-  cursor: pointer;
+.dialog-subtitle {
+  margin-top: 5px;
+  font-size: 15px;
+  color: rgb(131, 0, 191);
+}
+
+.el-button {
+  margin: 5px 0px;
 }
 
 :deep(.el-card) {
+  width: 100%;
   --el-card-padding: 8px;
   border: 0;
   cursor: pointer;