{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["tabs","tab"]},"type":"markdown"},"seo":{"title":"Custom ComponentNode","description":"Accelerate E&P application development and protect your innovation by consuming our Data and Domain APIs / Platform APIs.","lang":"en-US","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":true,"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"custom-componentnode","__idx":0},"children":["Custom ComponentNode"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This tutorial shows how to create custom component node implementations derived from the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/doc/classes/geotoolkit.schematics.scene.componentnode.componentnode.html"},"children":["ComponentNode"]}]}," class."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The key idea is that ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["data passed to custom elements is NOT restricted to any specific format"]},". Instead, the developer is responsible for defining how his/her data is interpreted and converted to a CarnacJS node or shape.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"In this tutorial, data (geometries) for ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["SimpleComponentNode"]}," objects are structured as JSON objects."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Also, a trivial implementation of ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/doc/classes/geotoolkit.schematics.factory.abstractcomponentnodefactory.abstractcomponentnodefactory.html"},"children":["AbstractComponentNodeFactory"]}]}," is provided that returns the node's class instance in its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createComponentNode()"]}," method call."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["General information (how to register your custom component, how to add data of the component's to a wellbore, how to get it visualized) is represented in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/GeneralInformation/customNodes"},"children":["General Information"]}," tutorial."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"tubing-schematic-element-implementation","__idx":1},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/CustomComponentNode/customComponentNode#tubing"},"children":["#"]}," 'Tubing' Schematic Element Implementation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is an example of a \"tubing\" schematic element implementation:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"main","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"ts","header":{"controls":{"copy":{}}},"source":"import { Plot } from \"@int/geotoolkit/plot/Plot.ts\";\nimport { Rect } from \"@int/geotoolkit/util/Rect.ts\";\nimport { Events } from \"@int/geotoolkit/scene/Node.ts\";\nimport { SimpleComponentNodeFactory } from \"/src/code/Schematics/CustomComponentNode/simpleComponentNodeFactory.ts\";\nimport { ComponentNodeFactoryRegistry } from \"@int/geotoolkit/schematics/factory/ComponentNodeFactoryRegistry.ts\";\nimport { WellBoreData } from \"@int/geotoolkit/schematics/data/WellBoreData.ts\";\nimport { WellBoreNode } from \"@int/geotoolkit/schematics/scene/WellBoreNode.ts\";\nconst createScene = (canvas) => {\n  const componentName = \"MySimpleComponent\";\n  const nodeFactory = new SimpleComponentNodeFactory();\n  const factoryRegistry = new ComponentNodeFactoryRegistry();\n  factoryRegistry.setFactory(componentName, nodeFactory);\n  const wellBoreData = new WellBoreData();\n  const shapeOptions = {\n    \"geometry\": {},\n    \"top\": 50,\n    \"bottom\": 100,\n    \"left\": -25,\n    \"right\": 25\n  };\n  wellBoreData.addComponent(componentName, shapeOptions);\n  const wellBoreNode = new WellBoreNode({\n    \"data\": wellBoreData,\n    \"registry\": factoryRegistry\n  });\n  const plotMinY = 0, plotMaxY = 250, plotMinX = 0, plotMaxX = 250;\n  const plotSizeX = plotMaxX - plotMinX;\n  const plotSizeY = plotMaxY - plotMinY;\n  wellBoreNode.setBounds(new Rect(\n    plotMinX + plotSizeX / 4,\n    plotMinY,\n    plotMaxX - plotSizeX / 4,\n    plotMaxY\n  ));\n  const plot = new Plot({\n    \"canvaselement\": canvas,\n    \"root\": wellBoreNode\n  });\n  wellBoreNode.on(Events.Invalidate, () => plot.update());\n  plot.setSize(plotSizeX, plotSizeY);\n  return plot;\n};\nexport {\n  createScene\n};\n\ncreateScene(document.querySelector('[ref=\"plot\"]'));\n\n","lang":"ts"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"css","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"css","header":{"controls":{"copy":{}}},"source":"\n.cg-tooltip-holder {\n  position: relative;\n}\n\n.cg-tooltip {\n  position: absolute;\n  display: block;\n  padding: 2px 12px 3px 7px;\n  overflow: visible !important;\n  font-family: Roboto, Helvetica, Arial, sans-serif;\n  font-size: 13px;\n  background: white !important;\n  opacity: 0.9;\n  color: #333333;\n  border: solid 1px gray;\n  border-radius: 5px;\n  text-align: left;\n  box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2), 0 6px 20px 0 rgba(0, 0, 0, 0.19);\n  border-radius: 5px;\n  margin: 0 !important;\n  z-index: 10000;\n  max-width: 400px;\n  text-wrap: normal !important;\n  white-space: normal !important;\n}\n/* Default setting for tooltip */\n.cg-tooltip-container {\n  position: absolute;\n  display: block;\n  overflow: visible !important;\n  font-family: Roboto, Helvetica, Arial, sans-serif;\n  font-size: 12px;\n  padding: 3px 7px;\n  background: #f7f7f7;\n  color: #333333;\n  border: 1px solid #938e8e;\n  opacity: 0.8;\n  text-align: left;\n  box-shadow: 3px 3px 10px #888;\n  margin: 0 !important;\n  z-index: 10000;\n  max-width: 400px;\n  text-wrap: normal !important;\n  white-space: normal !important;\n  user-select: none;\n}\n@media screen and (-ms-high-contrast: active), (-ms-high-contrast: none) {\n  .cg-tooltip-container {\n    border-radius: 0;\n  }\n}\n/* Default left arrow for tooltip */\n.cg-tooltip-arrow-left::before {\n  content: '';\n  position: absolute;\n  display: block;\n  width: 0px;\n  left: 0;\n  top: 50%;\n  border: 5px solid transparent;\n  border-left: 0;\n  border-right: 5px solid  #938e8e;\n  transform: translate(calc(-100%), -50%);\n}\n.cg-tooltip-arrow-left::after {\n  content: '';\n  position: absolute;\n  display: block;\n  width: 0px;\n  left: 0;\n  top: 50%;\n  border: 4px solid transparent;\n  border-left: 0;\n  border-right: 4px solid #f7f7f7;\n  transform: translate(calc(-100%), -50%);\n}\n/* Default top arrow for tooltip */\n.cg-tooltip-arrow-top::before {\n  content: '';\n  position: absolute;\n  display: block;\n  width: 0px;\n  left: 50%;\n  top: 0;\n  border: 5px solid transparent;\n  border-top: 0;\n  border-bottom: 5px solid #938e8e;\n  transform: translate(-50%, -100%);\n}\n.cg-tooltip-arrow-top::after {\n  content: '';\n  position: absolute;\n  display: block;\n  width: 0px;\n  left: 50%;\n  top: 0;\n  border: 4px solid transparent;\n  border-top: 0;\n  border-bottom: 4px solid #f7f7f7;\n  transform: translate(-50%, -100%);\n}\n/* Default right arrow for tooltip */\n.cg-tooltip-arrow-right::before {\n  content: '';\n  position: absolute;\n  display: block;\n  width: 0px;\n  right: 0;\n  top: 50%;\n  border: 5px solid transparent;\n  border-right: 0;\n  border-left: 5px solid #938e8e;\n  transform: translate(100%, -50%);\n}\n.cg-tooltip-arrow-right::after {\n  content: '';\n  position: absolute;\n  display: block;\n  width: 0px;\n  right: 0;\n  top: 50%;\n  border: 4px solid transparent;\n  border-right: 0;\n  border-left: 4px solid #f7f7f7;\n  transform: translate(100%, -50%);\n}\n/* Default bottom arrow for tooltip */\n.cg-tooltip-arrow-bottom::before {\n  content: '';\n  position: absolute;\n  display: block;\n  width: 0px;\n  left: 50%;\n  bottom: 0px;\n  border: 5px solid transparent;\n  border-bottom: 0;\n  border-top: 5px solid #938e8e;\n  transform: translate(-50%, 100%);\n  z-index: 10000;\n}\n.cg-tooltip-arrow-bottom::after {\n  content: '';\n  position: absolute;\n  display: block;\n  width: 0px;\n  left: 50%;\n  bottom: 0;\n  border: 4px solid transparent;\n  border-bottom: 0;\n  border-top: 4px solid #f7f7f7;\n  transform: translate(-50%, 100%);\n  z-index: 10000;\n}\n/* Tooltip item name */\n/* Tooltip item value */\n/* .cg-tooltip-item-value */\n/* Tooltip item value */\n.cg-tooltip-item-unit {\n  text-transform: none;\n}\n\n.cg-tooltip-item-name {\n    text-transform: capitalize;\n    white-space: nowrap;\n    vertical-align: middle;\n    font-size: 13px;\n}\n.cg-tooltip-row {\n  display: flex;\n  flex-direction: row;\n  align-items: center;\n  white-space: pre-wrap;\n  font-size: 12px;\n  line-height: 100%;\n  margin: 1px 0;\n}\n.cg-tooltip-title {\n  font-size: 13px;\n  height: 14px;\n  text-transform: capitalize;\n}\n.cg-tooltip-title .cg-tooltip-symbol {\n  margin-right: 0 !important;\n}\n.cg-tooltip-title-name {\n  vertical-align: middle;\n}\n.cg-tooltip-row + .cg-tooltip-row {\n  margin-top: 4px;\n}\n.cg-tooltip-row.cg-tooltip-title + .cg-tooltip-row {\n  margin-top: 5px;\n}\n.cg-tooltip-item-value + .cg-tooltip-item-unit {\n    margin-left: 1px;\n}\n/* Tooltip symbol */\n.cg-tooltip-symbol-cell {\n  display: inline-flex;\n  min-width: 13px; /* 10px size + 3px margin */\n}\n.cg-tooltip-symbol {\n  margin-right: 3px;\n  background-color: transparent;\n  display: block;\n}\n.cg-tooltip-symbol > img {\n  display: block;\n}\n.cg-tooltip-list-cell {\n  display: inline-flex;\n}\n.cg-tooltip-list-symbol {\n  display: block;\n  margin-right: 3px;\n  width: 6px;\n  height: 6px;\n  vertical-align: middle;\n  border-radius: 50%;\n  border: 1px solid rgba(0,0,0,.4);\n}\n.cg-tooltip-symbol-legacy {\n  border-radius: 4px;\n  margin-right: 5px;\n  height: 8px;\n  width: 8px;\n  display: inline-block;\n}\n.cg-tooltip-title-legacy {\n  font-weight: 900;\n}\n\n/* Tooltip symbol circle */\n.cg-tooltip-symbol.circle {\n  height: 10px;\n  width: 10px;\n  display: inline-block;\n  border-radius: 50%;\n  border: 1px solid rgba(0,0,0,.4);\n}\n/* Tooltip symbol line */\n.cg-tooltip-symbol.line {\n    height: 10px;\n    width: 10px;\n    display: inline-block;\n    transform: scale(1.2, 0.2);\n}\n/* Tooltip symbol diamond */\n.cg-tooltip-symbol.diamond {\n    height: 10px;\n    width: 10px;\n    display: inline-block;\n    transform: rotate(45deg);\n    border-radius: 0px;\n}\n/* Tooltip symbol square */\n.cg-tooltip-symbol.square {\n    height: 10px;\n    width: 10px;\n    display: inline-block;\n    border-radius: 0px;\n    border: 1px solid rgba(0,0,0,.4);\n}\n\n","lang":"css"},"children":[]}]}]},{"$$mdtype":"Tag","name":"iframe","attributes":{"src":"https://dc2-documentation.s3.amazonaws.com/documentation/slb-docs-test/5.0/examples/vue/tutorials/index.html#/Schematics/CustomComponentNode/customComponentNode?section=tubing&extract=true","width":"100%","height":"338.5px","style":{"border":"none"}},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"node-constructor","__idx":2},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/CustomComponentNode/customComponentNode#NodeConstructor"},"children":["#"]}," Node constructor"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Most of its code is essentially component data to Carnac shapes geometry conversion (a rectangle and two polygons filled with gradient fill style). The data is passed as a parameter to the node's constructor:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"node-geometry","__idx":3},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/CustomComponentNode/customComponentNode#NodeGeometry"},"children":["#"]}," Node geometry"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Then the node's geometry bounds gets by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["getGeometryBounds()"]}," method call:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[]}]},"headings":[{"value":"Custom ComponentNode","id":"custom-componentnode","depth":1},{"value":"'Tubing' Schematic Element Implementation","id":"tubing-schematic-element-implementation","depth":3},{"value":"Node constructor","id":"node-constructor","depth":3},{"value":"Node geometry","id":"node-geometry","depth":3}],"frontmatter":{"title":"Custom ComponentNode","seo":{"title":"Custom ComponentNode"}},"lastModified":"2026-02-11T19:54:32.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/geotoolkit/tutorials/schematics/custom-nodes/custom-component-node","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}