Introduction:

SpinalGraph is a data schema for grouping together a set of informations and modeling the links between these informations. This data schema works on the "context" layer of the pyramid of informations.

To get more information about SpinalGraph data architecture, please read SpinalGraph 0.2 Model description.

c'est un service qui permet d'enrengistrer sous forme d'applications des boutons en fonction de mot clé.

Avec les mots clés, les interfaces retrouvent/récupère les boutons associés aux applications. 

See https://material.io/tools/icons/?style=baseline for material icons

Usage:

To use the Spinal Context Menu Service, you must :

• Install :

npm install --save https://github.com/spinalcom/spinal-env-viewer-context-menu-service.git

• Import and instantiate

const {
  spinalContextMenuService,
  SpinalContextApp
} = require("spinal-env-viewer-context-menu-service");


// 1 Extends the class `SpinalContextApp` and define custom `isShown` and `action` methods.
class SpinalContextAppTest extends SpinalContextApp {
  constructor() {
// 2 testLabel : tooltip of the button  
//   test description : description of the button. it will be an evolution of the tooltip. 
    super("testlabel", "test description", {
//3 button config
      icon: "add",
      icon_type: "in",
      backgroundColor: "000000",
      fontColor: "FFFFFF"
    });
  }
//4 fonction to open panel.
  isShown(option) {
    if (option.testsFail === true) return Promise.resolve(-1);
    return Promise.resolve(true);
  }
//5 fonction executed after click
  action(option) {
    console.log("action clicked");
  }
}

Now we have to register the app to a  HookName.

Below you have a the list of HookName.

For example, there is 3 HookName example

• "circularMenu"
• "GraphManagerSideBar"
• "GraphManagerGlobalBar"

registerApp("myHookName", new SpinalContextAppTest())

spinalContextMenuService.registerApp("myHookName", new SpinalContextAppTest());

CircularMenu

Hook : circularMenu

Pour ajouter une fonction dans le circular menu il faut réaliser l'ensemble de cette procedure.

SideBar Graph Manager

Hook : sideBar

GlobalBar Graph Manager

Hook : globalBar

ViewerBar

Hook : viewerBar