Class: SVGMouseCursor
Extends
Constructors
new SVGMouseCursor()
new SVGMouseCursor(
url,x?,y?,name?,fallback?):SVGMouseCursor
Parameters
• url: string
• x?: number
• y?: number
• name?: string
• fallback?: MouseCursor
Returns
Overrides
Defined in
tools/src/cursors/SVGMouseCursor.ts:15
Methods
addFallbackStyleProperty()
addFallbackStyleProperty(
style):string
Parameters
• style: string
Returns
string
Inherited from
ImageMouseCursor.addFallbackStyleProperty
Defined in
tools/src/cursors/MouseCursor.ts:54
getName()
getName():
string
Returns
string
Inherited from
Defined in
tools/src/cursors/MouseCursor.ts:50
getStyleProperty()
getStyleProperty():
string
Returns
string
Inherited from
ImageMouseCursor.getStyleProperty
Defined in
tools/src/cursors/ImageMouseCursor.ts:27
getDefinedCursor()
staticgetDefinedCursor(name,pointer,color?):MouseCursor
Get a shared instance of the SVGMouseCursor class satisfying the given parameters.
Parameters
• name: string
The name of the cursor (defined in SVGCursorDescriptor.ts);
• pointer: boolean = false
Should be true to use the version of the cursor containing a mouse pointer. Defaults to false (which does not add a pointer to the cursor);
• color?: string
The color of the cursor. Defaults to tool.style.colorHighlightedActive;
Returns
a SVGMouseCursor instance or undefined if no SVG cursor descriptor was found with the given name;
Overrides
ImageMouseCursor.getDefinedCursor
Defined in
tools/src/cursors/SVGMouseCursor.ts:35
getUniqueInstanceName()
staticgetUniqueInstanceName(prefix):string
Parameters
• prefix: string
Returns
string
Inherited from
ImageMouseCursor.getUniqueInstanceName
Defined in
tools/src/cursors/ImageMouseCursor.ts:36
setDefinedCursor()
staticsetDefinedCursor(name,cursor):boolean
Parameters
• name: string
• cursor: MouseCursor
Returns
boolean
Inherited from
ImageMouseCursor.setDefinedCursor