{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["tabs","tab"]},"type":"markdown"},"seo":{"title":"Getting started","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":"getting-started","__idx":0},"children":["Getting started"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Schematics.JS is designed to visualize well downhole equipment throughout its lifecycle. It provides a flexible and high-quality graphic engine to accommodate the needs of a variety of applications such as well design, BHA displays for monitoring drilling operations or detailed wellbore schematic and well intervention visualization. Schematics.JS can visualize vertical, deviated, and horizontal wells."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Schematics.JS offers a wide set of ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/ElementsCatalog/elementsCatalog"},"children":["schematic elements"]}," and allows the user to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/GeneralInformation/customNodes"},"children":["extend or modify"]}," this set."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On other hand if a user is OK with a component's general graphical representation, though the component's shapes it's built of are expected to look different in terms of their line/fill styles, then ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/RenderingHints/renderingHints"},"children":["rendering hints"]}," can be used."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Linear or compressed views of the schematic data are available along with custom views support."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Also supported is animation (e.g., ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/Fluids/fluids"},"children":["displaying fluids"]}," inside a wellbore), ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/LabelingStrategy/labelingStrategy"},"children":["labeling strategies"]}," , ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/LithologyInSchematics/lithologyInSchematics"},"children":["lithology"]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/TrackSchematics/trackSchematics"},"children":["track schematics"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This Schematics tutorial demonstrates how to initialize schematics data and visualize it in HTML5 canvas. Familiarization with the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/pages/firstSteps"},"children":["First Step"]}," tutorial in CarnacJS is beneficial."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"data-initialization","__idx":1},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/GettingStarted/gettingStarted#init"},"children":["#"]}," Data initialization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Schematics data is stored in a ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/doc/classes/geotoolkit.schematics.data.wellboredata.wellboredata.html"},"children":["WellBoreData"]}]}," object which is a container to hold all the schematics components. The WellBoreData object uses its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addComponent"]}," method to accumulate components."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"wellbore-visualization","__idx":2},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/GettingStarted/gettingStarted#wellbore"},"children":["#"]}," Wellbore visualization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The steps required to visualize schematics data added to the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/doc/classes/geotoolkit.schematics.data.wellboredata.wellboredata.html"},"children":["WellBoreData"]}]}," object are:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/doc/classes/geotoolkit.schematics.scene.wellborenode.wellborenode.html"},"children":["WellBoreNode"]}]}," shape and pass the WellBoreData object as a parameter. WellBoreNode is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["geotoolkit/scene/Node"]}," implementation to visualize the schematics data that the user created."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If custom elements are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," needed (i.e. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["geotoolkit/schematics/scene/ComponentNode"]}," implementations), a reference to the data is the only argument to pass to WellBoreNode constructor. This is shown in the code below."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If custom elements ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["are"]}," needed, then a ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/doc/classes/geotoolkit.schematics.factory.componentnodefactoryregistry.componentnodefactoryregistry.html"},"children":["geotoolkit/schematics/factory/ComponentNodeFactoryRegistry"]}]}," instance must be passed as a parameter of the WellBoreNode initialization object.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Please refer to the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/Schematics/GeneralInformation/customNodes"},"children":["Nodes customization"]}," tutorial for more details."]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a Carnac ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/doc/classes/geotoolkit.plot.plot.plot.html"},"children":["Plot"]}]}," object and set the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#/doc/classes/geotoolkit.schematics.scene.wellborenode.wellborenode.html"},"children":["WellBoreNode"]}]}," shape as a root."]}]}]},{"$$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 { ViewMode, WellBoreNode } from \"@int/geotoolkit/schematics/scene/WellBoreNode.ts\";\nimport { Plot } from \"@int/geotoolkit/plot/Plot.ts\";\nimport { Rect } from \"@int/geotoolkit/util/Rect.ts\";\nimport { WellBoreData } from \"@int/geotoolkit/schematics/data/WellBoreData.ts\";\nimport data from \"/src/assets/data/wellBoreData.json?import\";\nconst createScene = (canvas) => {\n  const wellBoreNode = new WellBoreNode({\n    \"data\": new WellBoreData(data),\n    \"viewmode\": ViewMode.Compressed\n  });\n  const plot = new Plot({\n    \"canvaselement\": canvas,\n    \"root\": wellBoreNode\n  });\n  wellBoreNode.setBounds(new Rect(10, 0, 380, 750));\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/GettingStarted/gettingStarted?section=wellbore&extract=true","width":"100%","height":"838.5px","style":{"border":"none"}},"children":[]}]},"headings":[{"value":"Getting started","id":"getting-started","depth":1},{"value":"Data initialization","id":"data-initialization","depth":3},{"value":"Wellbore visualization","id":"wellbore-visualization","depth":3}],"frontmatter":{"title":"Getting started","seo":{"title":"Getting started"}},"lastModified":"2026-02-11T19:54:32.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/geotoolkit/tutorials/schematics/getting-started","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}