{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["tabs","tab"]},"type":"markdown"},"seo":{"title":"SVG Components","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":"svg-components","__idx":0},"children":["SVG Components"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This SVG Schematics tutorial shows how to create a schematic shape that uses SVG (Scalable Vector Graphics) formatted components along with JS components."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"components-registry","__idx":1},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/SVGComponents/svgComponents#Example1"},"children":["#"]}," Components Registry"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The key step is to define the components registry to connect with a SVG formatted visual representation and an element inside the data model:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["(see last section of the tutorial for more info on the loader's 'path' parameter)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"overwrite-registry","__idx":2},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/SVGComponents/svgComponents#Example2"},"children":["#"]}," Overwrite Registry"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If a JavaScript-based schematics component representation is preferred over a SVG one then corresponding entry in \"registrySVG\" instance need to be overwritten, for example:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"svg-schematics","__idx":3},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/SVGComponents/svgComponents#svgschematics"},"children":["#"]}," SVG Schematics"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After the \"registrySVG\" instance is filled in with all components, it is necessary to provide the registry to an instance of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["geotoolkit/schematics/widgets/CompositeSchematicsWidget"]}]},{"$$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 { CompositeSchematicsWidget } from \"@int/geotoolkit/schematics/widgets/CompositeSchematicsWidget.ts\";\nimport { Plot } from \"@int/geotoolkit/plot/Plot.ts\";\nimport { ComponentNodeFactoryRegistry } from \"@int/geotoolkit/schematics/factory/ComponentNodeFactoryRegistry.ts\";\nimport { SVGComponentsLoader } from \"@int/geotoolkit/schematics/factory/SVGComponentsLoader.ts\";\nimport { WellBoreData } from \"@int/geotoolkit/schematics/data/WellBoreData.ts\";\nimport data from \"/src/assets/data/wellBoreData.json?import\";\nfunction createScene(canvas) {\n  const widget = new CompositeSchematicsWidget({\n    \"annotationssizes\": { \"north\": 30 },\n    \"gap\": {\n      \"left\": { \"size\": \"20px\" },\n      \"top\": { \"size\": \"20px\" },\n      \"right\": { \"size\": \"20px\" },\n      \"bottom\": { \"size\": \"20px\" }\n    }\n  });\n  const plot = new Plot({\n    \"canvaselement\": canvas,\n    \"autorootbounds\": true,\n    \"root\": widget\n  });\n  const registrySVG = new ComponentNodeFactoryRegistry(false);\n  const loader = new SVGComponentsLoader({\n    \"registry\": registrySVG,\n    \"path\": RESOURCES + \"svg/components.json\"\n  });\n  loader.load().then(() => {\n    if (plot.isDisposed())\n      return;\n    const registryJS = new ComponentNodeFactoryRegistry(true);\n    registrySVG.setFactory(\"casing\", registryJS.getFactory(\"casing\"));\n    registrySVG.setFactory(\"perforation\", registryJS.getFactory(\"perforation\"));\n    widget.setProperties({ \"wellborenode\": { \"registry\": registrySVG } });\n    widget.setData(new WellBoreData(data));\n  });\n  return plot;\n}\nexport { createScene };\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/SVGComponents/svgComponents?section=svgschematics&extract=true","width":"100%","height":"788.5px","style":{"border":"none"}},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"svg-components-catalog","__idx":4},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/SVGComponents/svgComponents#Example3"},"children":["#"]}," SVG Components Catalog"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the Components Registry code section above, global variable ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RESOURCES"]}," is a string containing relative path to resources, SVG-components path is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RESOURCES + '/svg/components.json'"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"The JSON-file is essentially a catalog listing SVG-components provided with GeoToolkit (and, if necessary, extended by customer).",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"So, simplest format of an entry is just a component (SVG-file) name."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If a component needs to be displayed as a flipped one then pair of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"name\""]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"flipped\""]}," is used."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If flipping direction matters then extra parameter ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"left\""]}," is used:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[]}]},"headings":[{"value":"SVG Components","id":"svg-components","depth":1},{"value":"Components Registry","id":"components-registry","depth":3},{"value":"Overwrite Registry","id":"overwrite-registry","depth":3},{"value":"SVG Schematics","id":"svg-schematics","depth":3},{"value":"SVG Components Catalog","id":"svg-components-catalog","depth":3}],"frontmatter":{"title":"SVG Components","seo":{"title":"SVG Components"}},"lastModified":"2026-02-11T19:54:32.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/geotoolkit/tutorials/schematics/svg-components","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}