cornerstonejs#190 - update comments of the EllipticalROITool

md-prog · Aug 30, 2022 · b6e3ca4 · b6e3ca4
1 parent 861752f
commit b6e3ca4
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/packages/tools/src/tools/annotation/EllipticalROITool.ts b/packages/tools/src/tools/annotation/EllipticalROITool.ts
@@ -79,6 +79,9 @@ const { transformWorldToIndex } = csUtils;
  * ToolState manager and can be accessed from the ToolState by calling getAnnotations
  * or similar methods.
  *
+ * Changing tool configuration (see below) you can make the tool to draw the center
+ * point circle with a given radius.
+ *
  * ```js
  * cornerstoneTools.addTool(EllipticalROITool)
  *
@@ -95,6 +98,11 @@ const { transformWorldToIndex } = csUtils;
  *     },
  *   ],
  * })
+ *
+ * // draw a circle at the center point with 4px radius.
+ * toolGroup.setToolConfiguration(EllipticalROITool.toolName, {
+ *   centerPointRadius: 4,
+ * });
  * ```
  *
  * Read more in the Docs section of the website.