{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Namespace: Cylinder","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":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/readme"},"children":["API"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d"},"children":["geotoolkit3d"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3"},"children":["scene"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.well-1"},"children":["well"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.well-1.schematic"},"children":["schematic"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.well-1.schematic.cylinder"},"children":["Cylinder"]}," / Cylinder"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"namespace-cylinder","__idx":0},"children":["Namespace: Cylinder"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.well-1.schematic"},"children":["schematic"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.well-1.schematic.cylinder"},"children":["Cylinder"]},".Cylinder"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"table-of-contents","__idx":1},"children":["Table of contents"]},{"$$mdtype":"Tag","name":"details","attributes":{"open":"true"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"fontSize":"1.25em","fontWeight":"bold"}},"children":["Type Aliases"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.well-1.schematic.cylinder.cylinder#options"},"children":["Options"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.well-1.schematic.cylinder.cylinder#optionsbase"},"children":["OptionsBase"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.well-1.schematic.cylinder.cylinder#optionsbaseout"},"children":["OptionsBaseOut"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"contents","__idx":2},"children":["Contents"]},{"$$mdtype":"Tag","name":"details","attributes":{"open":"true"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"fontSize":"1.25em","fontWeight":"bold"}},"children":["Type Aliases"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"options","__idx":3},"children":["Options"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ƭ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Options"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The options"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"type-declaration","__idx":4},"children":["Type declaration"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["{ ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"[] ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["y"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"[] ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["z"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"[]  }"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["2 points minimum required; if 2 points are provided the first one is the localisation and the second provide the direction to tend to. If more than 2 points are provided then the points are actual trajectory points around which a tube will be created."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.x"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"[]"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The x deviation values"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.y"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"[]"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The y deviation values"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.z"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"[]"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The elevation values"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["depth?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The length of the cylinder in modelspace (used if there is only 2 points in the given path)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fillstyle?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit.attributes.fillstyle.fillstyle#type"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Type"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The cylinder fill style"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["radius?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The radius of the cylinder in modelspace"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tubeprecision?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The tube approximation precision"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["width?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["-"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"optionsbase","__idx":5},"children":["OptionsBase"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ƭ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OptionsBase"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.well-1.schematic.cylinder.cylinder#options"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}]}," & ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.well-1.schematic.schematicbase.schematicbase#optionsbase"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OptionsBase"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"optionsbaseout","__idx":6},"children":["OptionsBaseOut"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ƭ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OptionsBaseOut"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Required"]},"<",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.well-1.schematic.cylinder.cylinder#options"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}]},"> & ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.well-1.schematic.schematicbase.schematicbase#optionsbaseout"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OptionsBaseOut"]}]}]}]}]},"headings":[{"value":"Namespace: Cylinder","id":"namespace-cylinder","depth":1},{"value":"Table of contents","id":"table-of-contents","depth":2},{"value":"Contents","id":"contents","depth":2},{"value":"Options","id":"options","depth":4},{"value":"Type declaration","id":"type-declaration","depth":4},{"value":"OptionsBase","id":"optionsbase","depth":4},{"value":"OptionsBaseOut","id":"optionsbaseout","depth":4}],"frontmatter":{"seo":{"title":"Namespace: Cylinder"}},"lastModified":"2026-02-11T19:54:32.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.well-1.schematic.cylinder.cylinder","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}