{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Namespace: PolarGrid","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.grid-1"},"children":["grid"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.grid-1.polargrid"},"children":["PolarGrid"]}," / PolarGrid"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"namespace-polargrid","__idx":0},"children":["Namespace: PolarGrid"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.grid-1"},"children":["grid"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.grid-1.polargrid"},"children":["PolarGrid"]},".PolarGrid"]},{"$$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.grid-1.polargrid.polargrid#additionalaxismarkers"},"children":["AdditionalAxisMarkers"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.grid-1.polargrid.polargrid#additionalgridmarkers"},"children":["AdditionalGridMarkers"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.grid-1.polargrid.polargrid#formatterfunction"},"children":["FormatterFunction"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.grid-1.polargrid.polargrid#options"},"children":["Options"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.grid-1.polargrid.polargrid#optionsout"},"children":["OptionsOut"]}]}]}]}]}]}]},{"$$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":"additionalaxismarkers","__idx":3},"children":["AdditionalAxisMarkers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ƭ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["AdditionalAxisMarkers"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Record"]},"<",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},", { ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["linestyle?"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit.attributes.linestyle.linestyle#type"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Type"]}]}," ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text?"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}," ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["textstyle?"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit.attributes.textstyle.textstyle#type"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Type"]}]},"  }>"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Custom axis tick options, key number is angle in degree from 0 to 360"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"additionalgridmarkers","__idx":4},"children":["AdditionalGridMarkers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ƭ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["AdditionalGridMarkers"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Record"]},"<",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},", { ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["linestyle?"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit.attributes.linestyle.linestyle#type"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Type"]}]},"  }>"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Custom grid tick options, key number is radius in model space, it should be in interval [modelCenter, modelCenter + modelSize] to be visible"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"formatterfunction","__idx":5},"children":["FormatterFunction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ƭ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["FormatterFunction"]},": (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["el"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},") => ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"type-declaration","__idx":6},"children":["Type declaration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["el"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["User-defined formatter function which provide a number as input, and expect a string as a return."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"parameters","__idx":7},"children":["Parameters"]},{"$$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":{"width":"65%","data-label":"Name"},"children":["Name "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"35%","data-label":"Type"},"children":["Type "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["el"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"returns","__idx":8},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"options","__idx":9},"children":["Options"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ƭ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Options"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Omit"]},"<",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.object3d.object3d#options"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"isselectable\""]},"> & { ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["angletickgenerator?"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TickGenerator"]}]}," ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["axis?"]},": { ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional?"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.grid-1.polargrid.polargrid#additionalaxismarkers"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdditionalAxisMarkers"]}]}," ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["formatter?"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.grid-1.polargrid.polargrid#formatterfunction"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FormatterFunction"]}]}," ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["linestyle?"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit.attributes.linestyle.linestyle#type"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Type"]}]}," ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["outline?"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.text2d.text2d#outlineoptions"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OutlineOptions"]}]}," ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["textstyle?"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit.attributes.textstyle.textstyle#type"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Type"]}]},"  } ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["axiscount?"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}," ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["count?"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}," ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["grid?"]},": { ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional?"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.grid-1.polargrid.polargrid#additionalgridmarkers"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdditionalGridMarkers"]}]}," ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["linestyle?"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit.attributes.linestyle.linestyle#type"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Type"]}]},"  } ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modelcenter?"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}," ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modelsize?"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}," ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["radialtickgenerator?"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TickGenerator"]}]},"  }"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Polar Grid options."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"optionsout","__idx":10},"children":["OptionsOut"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ƭ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OptionsOut"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Required"]},"<",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.object3d.object3d#options"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}]},"> & ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.grid-1.polargrid.polargrid#options"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}]}]}]}]},"headings":[{"value":"Namespace: PolarGrid","id":"namespace-polargrid","depth":1},{"value":"Table of contents","id":"table-of-contents","depth":2},{"value":"Contents","id":"contents","depth":2},{"value":"AdditionalAxisMarkers","id":"additionalaxismarkers","depth":4},{"value":"AdditionalGridMarkers","id":"additionalgridmarkers","depth":4},{"value":"FormatterFunction","id":"formatterfunction","depth":4},{"value":"Type declaration","id":"type-declaration","depth":4},{"value":"Parameters","id":"parameters","depth":5},{"value":"Returns","id":"returns","depth":5},{"value":"Options","id":"options","depth":4},{"value":"OptionsOut","id":"optionsout","depth":4}],"frontmatter":{"seo":{"title":"Namespace: PolarGrid"}},"lastModified":"2026-02-11T19:54:32.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.grid-1.polargrid.polargrid","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}