Added legend to cursros/index.js as well as to MouseCursor.

cornerstonejs · Apr 1, 2019 · 8544854 · 8544854
1 parent 34006d0
commit 8544854
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/src/tools/cursors/MouseCursor.js b/src/tools/cursors/MouseCursor.js
@@ -7,7 +7,7 @@ const cursorModule = modules.cursor;
 MACROS:
 
 The following keys will have the appropriate value injected when
-the SVG is requested:
+an SVG is requested:
 
 - ACTIVE_COLOR  => options.activeColor || toolColors.getActiveColor();
 - TOOL_COLOR    => options.toolColor || toolColors.getToolColor();

diff --git a/src/tools/cursors/index.js b/src/tools/cursors/index.js
@@ -1,5 +1,16 @@
 import MouseCursor from './MouseCursor.js';
 
+/*
+MACROS:
+
+The following keys will have the appropriate value injected by the MouseCursor
+class when an SVG is requested:
+
+- ACTIVE_COLOR  => options.activeColor || toolColors.getActiveColor();
+- TOOL_COLOR    => options.toolColor || toolColors.getToolColor();
+- FILL_COLOR    => options.fillColor || toolColors.getFillColor();
+*/
+
 export const angleCursor = new MouseCursor(
   `<path fill="ACTIVE_COLOR" d="M1203 544q0 13-10 23l-393 393 393 393q10 10 10 23t-10 23l-50
         50q-10 10-23 10t-23-10l-466-466q-10-10-10-23t10-23l466-466q10-10 23-10t23