[{"data":1,"prerenderedAt":486},["ShallowReactive",2],{"page-\u002Frender\u002Fapi\u002Ffunctions\u002FformatDiameter":3,"navigation":99},{"collection":4,"page":5},"docs_en",{"id":6,"title":7,"body":8,"description":89,"extension":90,"meta":91,"navigation":93,"path":94,"rawbody":95,"seo":96,"stem":97,"__hash__":98},"docs_en\u002Frender\u002Fapi\u002Ffunctions\u002FformatDiameter.md","formatDiameter",{"type":9,"value":10,"toc":78},"minimark",[11,36,39,44,47,52,54,59,61,70,74],[12,13,14],"blockquote",{},[15,16,17,20,21,25,26,25,29,32,33],"p",{},[18,19,7],"strong",{},"(",[22,23,24],"code",{},"mm",", ",[22,27,28],{},"units",[22,30,31],{},"locale","): ",[22,34,35],{},"string",[15,37,38],{},"Formats a diameter value in millimetres to the active diameter unit\nstring, rounded (never raw floating-point) and using the target locale's\ndecimal separator.",[40,41,43],"h2",{"id":42},"parameters","Parameters",[45,46,24],"h3",{"id":24},[15,48,49],{},[22,50,51],{},"number",[45,53,28],{"id":28},[15,55,56],{},[22,57,58],{},"DiameterUnits",[45,60,31],{"id":31},[15,62,63,66,67],{},[22,64,65],{},"\"en\""," | ",[22,68,69],{},"\"pt\"",[40,71,73],{"id":72},"returns","Returns",[15,75,76],{},[22,77,35],{},{"title":79,"searchDepth":80,"depth":80,"links":81},"",2,[82,88],{"id":42,"depth":80,"text":43,"children":83},[84,86,87],{"id":24,"depth":85,"text":24},3,{"id":28,"depth":85,"text":28},{"id":31,"depth":85,"text":31},{"id":72,"depth":80,"text":73},"Formats a diameter value in millimetres to the active diameter unit string, rounded (never raw floating-point) and using the target locale's decimal separator.","md",{"generated":92},true,false,"\u002Frender\u002Fapi\u002Ffunctions\u002FformatDiameter","---\npath: \"\u002Frender\u002Fapi\u002Ffunctions\u002FformatDiameter\"\ntitle: formatDiameter\ndescription: \"Formats a diameter value in millimetres to the active diameter unit string, rounded (never raw floating-point) and using the target locale's decimal separator.\"\ngenerated: true\nnavigation: false\n---\n\n> **formatDiameter**(`mm`, `units`, `locale`): `string`\n\nFormats a diameter value in millimetres to the active diameter unit\nstring, rounded (never raw floating-point) and using the target locale's\ndecimal separator.\n\n## Parameters\n\n### mm\n\n`number`\n\n### units\n\n`DiameterUnits`\n\n### locale\n\n`\"en\"` \\| `\"pt\"`\n\n## Returns\n\n`string`\n",{"title":7,"description":89},"render\u002Fapi\u002Ffunctions\u002FformatDiameter","ufBRU4T_d5zQS2mZf2JlU8nj7-CTyVKy1InDdlxvQGo",{"docs_en":100,"spec":417,"changelogs":467},[101,121,140,195,305,359],{"title":102,"path":103,"stem":104,"children":105},"Ai","\u002Fai","ai",[106,109,113,117],{"title":107,"path":103,"stem":108},"Introduction","ai\u002Findex",{"title":110,"path":111,"stem":112},"Converting reports with an assistant","\u002Fai\u002Fconversion-skill","ai\u002Fconversion-skill",{"title":114,"path":115,"stem":116},"llms.txt and Markdown pages","\u002Fai\u002Fllms","ai\u002Fllms",{"title":118,"path":119,"stem":120},"MCP server","\u002Fai\u002Fmcp","ai\u002Fmcp",{"title":122,"path":123,"stem":124,"children":125},"Contributing","\u002Fcontributing","contributing",[126,128,132,136],{"title":107,"path":123,"stem":127},"contributing\u002Findex",{"title":129,"path":130,"stem":131},"Writing docs","\u002Fcontributing\u002Fwriting-docs","contributing\u002F1.writing-docs",{"title":133,"path":134,"stem":135},"Update rules","\u002Fcontributing\u002Fupdate-rules","contributing\u002F2.update-rules",{"title":137,"path":138,"stem":139},"Content components","\u002Fcontributing\u002Fcomponents","contributing\u002Fcomponents",{"title":141,"path":142,"stem":143,"children":144},"Core","\u002Fcore","core",[145,147,160,189],{"title":107,"path":142,"stem":146},"core\u002Findex",{"title":148,"path":149,"stem":150,"children":151,"page":93},"Getting Started","\u002Fcore\u002Fgetting-started","core\u002F1.getting-started",[152,156],{"title":153,"path":154,"stem":155},"Installation","\u002Fcore\u002Fgetting-started\u002Finstallation","core\u002F1.getting-started\u002F1.installation",{"title":157,"path":158,"stem":159},"First use","\u002Fcore\u002Fgetting-started\u002Ffirst-use","core\u002F1.getting-started\u002F2.first-use",{"title":161,"path":162,"stem":163,"children":164,"page":93},"Guides","\u002Fcore\u002Fguides","core\u002F2.guides",[165,169,173,177,181,185],{"title":166,"path":167,"stem":168},"Parsing and validating","\u002Fcore\u002Fguides\u002Fparsing-and-validating","core\u002F2.guides\u002F1.parsing-and-validating",{"title":170,"path":171,"stem":172},"Serializing and sharing","\u002Fcore\u002Fguides\u002Fserializing-and-sharing","core\u002F2.guides\u002F2.serializing-and-sharing",{"title":174,"path":175,"stem":176},"Unit conversion","\u002Fcore\u002Fguides\u002Funit-conversion","core\u002F2.guides\u002F3.unit-conversion",{"title":178,"path":179,"stem":180},"Vocabularies and textures","\u002Fcore\u002Fguides\u002Fvocabularies-and-textures","core\u002F2.guides\u002F4.vocabularies-and-textures",{"title":182,"path":183,"stem":184},"Water quality vocabulary","\u002Fcore\u002Fguides\u002Fwater-quality-vocabulary","core\u002F2.guides\u002F5.water-quality-vocabulary",{"title":186,"path":187,"stem":188},"Versions and time zones","\u002Fcore\u002Fguides\u002Fversions-and-time-zones","core\u002F2.guides\u002F6.versions-and-time-zones",{"title":190,"path":191,"stem":192,"children":193},"API reference","\u002Fcore\u002Fapi","core\u002Fapi\u002Findex",[194],{"title":190,"path":191,"stem":192},{"title":196,"path":197,"stem":198,"children":199},"Format","\u002Fformat","format",[200,202,222,251,275,295,301],{"title":107,"path":197,"stem":201},"format\u002Findex",{"title":148,"path":203,"stem":204,"children":205,"page":93},"\u002Fformat\u002Fgetting-started","format\u002F1.getting-started",[206,210,214,218],{"title":207,"path":208,"stem":209},"What is .well?","\u002Fformat\u002Fgetting-started\u002Fwhat-is-well","format\u002F1.getting-started\u002F1.what-is-well",{"title":211,"path":212,"stem":213},"For geologists","\u002Fformat\u002Fgetting-started\u002Ffor-geologists","format\u002F1.getting-started\u002F2.for-geologists",{"title":215,"path":216,"stem":217},"For developers","\u002Fformat\u002Fgetting-started\u002Ffor-developers","format\u002F1.getting-started\u002F3.for-developers",{"title":219,"path":220,"stem":221},"Your first .well file","\u002Fformat\u002Fgetting-started\u002Ffirst-well-file","format\u002F1.getting-started\u002F4.first-well-file",{"title":223,"path":224,"stem":225,"children":226,"page":93},"Concepts","\u002Fformat\u002Fconcepts","format\u002F2.concepts",[227,231,235,239,243,247],{"title":228,"path":229,"stem":230},"Depths and intervals","\u002Fformat\u002Fconcepts\u002Fdepths-and-intervals","format\u002F2.concepts\u002F1.depths-and-intervals",{"title":232,"path":233,"stem":234},"Units and precision","\u002Fformat\u002Fconcepts\u002Funits-and-precision","format\u002F2.concepts\u002F2.units-and-precision",{"title":236,"path":237,"stem":238},"Vocabularies","\u002Fformat\u002Fconcepts\u002Fvocabularies","format\u002F2.concepts\u002F3.vocabularies",{"title":240,"path":241,"stem":242},"Profiles","\u002Fformat\u002Fconcepts\u002Fprofiles","format\u002F2.concepts\u002F4.profiles",{"title":244,"path":245,"stem":246},"Versions and deprecation","\u002Fformat\u002Fconcepts\u002Fversions-and-deprecation","format\u002F2.concepts\u002F5.versions-and-deprecation",{"title":248,"path":249,"stem":250},"Extensibility","\u002Fformat\u002Fconcepts\u002Fextensibility","format\u002F2.concepts\u002F6.extensibility",{"title":161,"path":252,"stem":253,"children":254,"page":93},"\u002Fformat\u002Fguides","format\u002F3.guides",[255,259,263,267,271],{"title":256,"path":257,"stem":258},"Writing a .well by hand","\u002Fformat\u002Fguides\u002Fwriting-by-hand","format\u002F3.guides\u002F1.writing-by-hand",{"title":260,"path":261,"stem":262},"Converting a report","\u002Fformat\u002Fguides\u002Fconverting-a-report","format\u002F3.guides\u002F2.converting-a-report",{"title":264,"path":265,"stem":266},"Validating","\u002Fformat\u002Fguides\u002Fvalidating","format\u002F3.guides\u002F3.validating",{"title":268,"path":269,"stem":270},"Extending for your own needs","\u002Fformat\u002Fguides\u002Fextending","format\u002F3.guides\u002F4.extending",{"title":272,"path":273,"stem":274},"Building an editor or database on .well","\u002Fformat\u002Fguides\u002Fbuilding-on-well","format\u002F3.guides\u002F5.building-on-well",{"title":276,"path":277,"stem":278,"children":279},"Overview","\u002Fformat\u002Freference","format\u002F4.reference\u002Findex",[280,281,285,289],{"title":276,"path":277,"stem":278},{"title":282,"path":283,"stem":284},"JSON Schema","\u002Fformat\u002Freference\u002Fjson-schema","format\u002F4.reference\u002F1.json-schema",{"title":286,"path":287,"stem":288},"Example wells","\u002Fformat\u002Freference\u002Fexamples","format\u002F4.reference\u002F2.examples",{"title":290,"path":291,"stem":292,"children":293},"Object reference","\u002Fformat\u002Freference\u002Fobjects","format\u002Freference\u002Fobjects\u002Findex",[294],{"title":290,"path":291,"stem":292},{"title":296,"path":297,"stem":298,"children":299},"About the spec","\u002Fformat\u002Fspec","format\u002F5.spec\u002Findex",[300],{"title":296,"path":297,"stem":298},{"title":302,"path":303,"stem":304},"Changelog","\u002Fformat\u002Fchangelog","format\u002F6.changelog",{"title":306,"path":307,"stem":308,"children":309},"Render","\u002Frender","render",[310,312,322,354],{"title":107,"path":307,"stem":311},"render\u002Findex",{"title":148,"path":313,"stem":314,"children":315,"page":93},"\u002Frender\u002Fgetting-started","render\u002F1.getting-started",[316,319],{"title":153,"path":317,"stem":318},"\u002Frender\u002Fgetting-started\u002Finstallation","render\u002F1.getting-started\u002F1.installation",{"title":157,"path":320,"stem":321},"\u002Frender\u002Fgetting-started\u002Ffirst-use","render\u002F1.getting-started\u002F2.first-use",{"title":161,"path":323,"stem":324,"children":325,"page":93},"\u002Frender\u002Fguides","render\u002F2.guides",[326,330,334,338,342,346,350],{"title":327,"path":328,"stem":329},"Panels and layout","\u002Frender\u002Fguides\u002Fpanels-and-layout","render\u002F2.guides\u002F1.panels-and-layout",{"title":331,"path":332,"stem":333},"Layers and labels","\u002Frender\u002Fguides\u002Flayers-and-labels","render\u002F2.guides\u002F2.layers-and-labels",{"title":335,"path":336,"stem":337},"Theming","\u002Frender\u002Fguides\u002Ftheming","render\u002F2.guides\u002F3.theming",{"title":339,"path":340,"stem":341},"Locale and units","\u002Frender\u002Fguides\u002Flocale-and-units","render\u002F2.guides\u002F4.locale-and-units",{"title":343,"path":344,"stem":345},"Legends","\u002Frender\u002Fguides\u002Flegends","render\u002F2.guides\u002F5.legends",{"title":347,"path":348,"stem":349},"Zoom, pan and highlights","\u002Frender\u002Fguides\u002Finteraction","render\u002F2.guides\u002F6.interaction",{"title":351,"path":352,"stem":353},"Using it in a framework","\u002Frender\u002Fguides\u002Fframeworks","render\u002F2.guides\u002F7.frameworks",{"title":190,"path":355,"stem":356,"children":357},"\u002Frender\u002Fapi","render\u002Fapi\u002Findex",[358],{"title":190,"path":355,"stem":356},{"title":360,"path":361,"stem":362,"children":363},"Utils","\u002Futils","utils",[364,366,376,412],{"title":107,"path":361,"stem":365},"utils\u002Findex",{"title":148,"path":367,"stem":368,"children":369,"page":93},"\u002Futils\u002Fgetting-started","utils\u002F1.getting-started",[370,373],{"title":153,"path":371,"stem":372},"\u002Futils\u002Fgetting-started\u002Finstallation","utils\u002F1.getting-started\u002F1.installation",{"title":157,"path":374,"stem":375},"\u002Futils\u002Fgetting-started\u002Ffirst-use","utils\u002F1.getting-started\u002F2.first-use",{"title":161,"path":377,"stem":378,"children":379,"page":93},"\u002Futils\u002Fguides","utils\u002F2.guides",[380,384,388,392,396,400,404,408],{"title":381,"path":382,"stem":383},"Geometry and volumes","\u002Futils\u002Fguides\u002Fgeometry-and-volumes","utils\u002F2.guides\u002F1.geometry-and-volumes",{"title":385,"path":386,"stem":387},"Water levels and pumping tests","\u002Futils\u002Fguides\u002Fpumping-tests","utils\u002F2.guides\u002F2.pumping-tests",{"title":389,"path":390,"stem":391},"Permits","\u002Futils\u002Fguides\u002Fpermits","utils\u002F2.guides\u002F3.permits",{"title":393,"path":394,"stem":395},"Operation and production","\u002Futils\u002Fguides\u002Foperation","utils\u002F2.guides\u002F4.operation",{"title":397,"path":398,"stem":399},"Water quality","\u002Futils\u002Fguides\u002Fwater-quality","utils\u002F2.guides\u002F5.water-quality",{"title":401,"path":402,"stem":403},"Logger import","\u002Futils\u002Fguides\u002Flogger-import","utils\u002F2.guides\u002F6.logger-import",{"title":405,"path":406,"stem":407},"SIAGAS import","\u002Futils\u002Fguides\u002Fsiagas-import","utils\u002F2.guides\u002F7.siagas-import",{"title":409,"path":410,"stem":411},"Formatting","\u002Futils\u002Fguides\u002Fformatting","utils\u002F2.guides\u002F8.formatting",{"title":190,"path":413,"stem":414,"children":415},"\u002Futils\u002Fapi","utils\u002Fapi\u002Findex",[416],{"title":190,"path":413,"stem":414},[418],{"title":196,"path":197,"stem":198,"children":419,"page":93},[420],{"title":421,"path":297,"stem":422,"children":423,"page":93},"Spec","format\u002Fspec",[424,433,442],{"title":425,"path":426,"stem":427,"children":428,"page":93},"Reference","\u002Fformat\u002Fspec\u002Freference","format\u002Fspec\u002Freference",[429],{"title":430,"path":431,"stem":432},"FGDC Texture Patterns Reference","\u002Fformat\u002Fspec\u002Freference\u002Ffgdc-textures","format\u002Fspec\u002Freference\u002Ffgdc-textures",{"title":434,"path":435,"stem":436,"children":437,"page":93},"V1","\u002Fformat\u002Fspec\u002Fv1","format\u002Fspec\u002Fv1",[438],{"title":439,"path":440,"stem":441},".well File Format Specification","\u002Fformat\u002Fspec\u002Fv1\u002Fwell-format","format\u002Fspec\u002Fv1\u002Fwell-format",{"title":443,"path":444,"stem":445,"children":446,"page":93},"V2","\u002Fformat\u002Fspec\u002Fv2","format\u002Fspec\u002Fv2",[447,451,455,459,463],{"title":448,"path":449,"stem":450},".well File Format Specification — Version 2.4: Format Reference","\u002Fformat\u002Fspec\u002Fv2\u002Fformat-reference","format\u002Fspec\u002Fv2\u002Fformat-reference",{"title":452,"path":453,"stem":454},".well File Format Specification — Version 2.4: Interoperability","\u002Fformat\u002Fspec\u002Fv2\u002Finteroperability","format\u002Fspec\u002Fv2\u002Finteroperability",{"title":456,"path":457,"stem":458},".well File Format Specification — Version 2.4: Object Schemas","\u002Fformat\u002Fspec\u002Fv2\u002Fobject-schemas","format\u002Fspec\u002Fv2\u002Fobject-schemas",{"title":460,"path":461,"stem":462},".well File Format Specification — Version 2.4: Overview","\u002Fformat\u002Fspec\u002Fv2\u002Foverview","format\u002Fspec\u002Fv2\u002Foverview",{"title":464,"path":465,"stem":466},".well File Format Specification — Version 2.4: Water Quality","\u002Fformat\u002Fspec\u002Fv2\u002Fwater-quality","format\u002Fspec\u002Fv2\u002Fwater-quality",[468,474,480],{"title":141,"path":142,"stem":143,"children":469,"page":93},[470],{"title":471,"path":472,"stem":473},"@welldot\u002Fcore","\u002Fcore\u002Fchangelog","core\u002FCHANGELOG",{"title":306,"path":307,"stem":308,"children":475,"page":93},[476],{"title":477,"path":478,"stem":479},"@welldot\u002Frender","\u002Frender\u002Fchangelog","render\u002FCHANGELOG",{"title":360,"path":361,"stem":362,"children":481,"page":93},[482],{"title":483,"path":484,"stem":485},"@welldot\u002Futils","\u002Futils\u002Fchangelog","utils\u002FCHANGELOG",1793050497661]