Cursor

Show usages

Represents a cursor object.

Inheritance Hierarchy

Cursor

Type Details

yFiles module: view

Constructors

Cursor

(url: string, alternative: Cursor)

Initializes a new Cursor instance using the provided url and an alternative.

Parameters

options - Object
A map of options to pass to the method.

url - string: The url pointing to the cursor's image.
alternative - Cursor: Cursors can be chained but the last alternative needs to be one of the predefined cursors.

Cursor

(url: string, x: number, y: number, alternative: Cursor)

Initializes a new Cursor instance using the provided url, hot-spot coordinates, and an alternative.

Parameters

options - Object
A map of options to pass to the method.

url - string: The url pointing to the cursor's image.
x - number: The x-coordinate of the cursor's hot-spot
y - number: The y-coordinate of the cursor's hot-spot
alternative - Cursor: Cursors can be chained but the last alternative needs to be one of the predefined cursors.

Methods

getSystemCursor

() : string

Returns the CSS text representation for the cursor and its alternatives.

Returns

↪string: The CSS text representation for the cursor.

Constants

ALIAS

: Cursor

Gets the cursor to be shown when an alias or shortcut can be created.

Remarks

This corresponds to the alias CSS cursor. This is how it appears in your browser (hover to see):

ALL_SCROLL

: Cursor

Gets the cursor indicating that something can be scrolled or panned.

Remarks

This corresponds to the all-scroll CSS cursor. This is how it appears in your browser (hover to see):

AUTO

: Cursor

Gets the cursor where the browser determines the actual cursor to be displayed.

Remarks

This corresponds to the auto CSS cursor. This is how it appears in your browser (hover to see):

CELL

: Cursor

Gets the cursor to indicate selection of a table cell..

Remarks

This corresponds to the cell CSS cursor. This is how it appears in your browser (hover to see):

COL_RESIZE

: Cursor

Gets the cursor for resizing columns.

Remarks

This corresponds to the col-resize CSS cursor. This is how it appears in your browser (hover to see):

CONTEXT_MENU

: Cursor

Gets the cursor to indicate that there is a context menu available.

Remarks

This corresponds to the context-menu CSS cursor. This is how it appears in your browser (hover to see):

COPY

: Cursor

Gets the cursor to be shown when something can be copied (often used for drag & drop).

Remarks

This corresponds to the copy CSS cursor. This is how it appears in your browser (hover to see):

CROSSHAIR

: Cursor

Gets the crosshair cursor.

Remarks

This corresponds to the crosshair CSS cursor. This is how it appears in your browser (hover to see):

DEFAULT

: Cursor

Gets the default cursor.

Remarks

This corresponds to the default CSS cursor. This is how it appears in your browser (hover to see):

E_RESIZE

: Cursor

Gets a cursor that indicates that an edge at the east will be moved.

Remarks

Depending on the browser this might just be a horizontal resize cursor.

This corresponds to the e-resize CSS cursor. This is how it appears in your browser (hover to see):

EW_RESIZE

: Cursor

Gets the horizontal resize cursor.

Remarks

This corresponds to the ew-resize CSS cursor. This is how it appears in your browser (hover to see):

GRAB

: Cursor

Gets the cursor indicating that something can be grabbed (usually in conjunction with GRABBING).

Remarks

This corresponds to the grab CSS cursor. This is how it appears in your browser (hover to see):

GRABBING

: Cursor

Gets the cursor indicating that something is currently being grabbed (usually in conjunction with GRAB ).

Remarks

This corresponds to the grabbing CSS cursor. This is how it appears in your browser (hover to see):

HELP

: Cursor

Gets the cursor that indicates that help is available for the object under the cursor.

Remarks

This corresponds to the help CSS cursor. This is how it appears in your browser (hover to see):

MOVE

: Cursor

Gets the move cursor.

Remarks

This corresponds to the move CSS cursor. This is how it appears in your browser (hover to see):

N_RESIZE

: Cursor

Gets a cursor that indicates that an edge at the north will be moved.

Remarks

Depending on the browser this might just be a vertical resize cursor.

This corresponds to the n-resize CSS cursor. This is how it appears in your browser (hover to see):

NE_RESIZE

: Cursor

Gets a cursor that indicates that edges at the north and east will be moved.

Remarks

Depending on the browser this might just be the diagonal resize cursor for NE to SW resizes.

This corresponds to the ne-resize CSS cursor. This is how it appears in your browser (hover to see):

NESW_RESIZE

: Cursor

Gets the diagonal resize cursor for NE to SW resizes.

Remarks

This corresponds to the nesw-resize CSS cursor. This is how it appears in your browser (hover to see):

NO_DROP

: Cursor

Gets the cursor to be shown where nothing can be dropped in a drag & drop operation.

Remarks

This corresponds to the no-drop CSS cursor. This is how it appears in your browser (hover to see):

NONE

: Cursor

Gets the invisible cursor.

Remarks

This corresponds to the none CSS cursor. This is how it appears in your browser (hover to see):

Property Value

The invisible cursor.

NOT_ALLOWED

: Cursor

Gets the cursor to be shown when an action cannot be done.

Remarks

This corresponds to the not-allowed CSS cursor. This is how it appears in your browser (hover to see):

NS_RESIZE

: Cursor

Gets the vertical resize cursor.

Remarks

This corresponds to the ns-resize CSS cursor. This is how it appears in your browser (hover to see):

NW_RESIZE

: Cursor

Gets a cursor that indicates that edges at the north and west will be moved.

Remarks

Depending on the browser this might just be the diagonal resize cursor for NW to SE resizes.

This corresponds to the nw-resize CSS cursor. This is how it appears in your browser (hover to see):

NWSE_RESIZE

: Cursor

Gets the diagonal resize cursor for NW to SE resizes.

Remarks

This corresponds to the nwse-resize CSS cursor. This is how it appears in your browser (hover to see):

POINTER

: Cursor

Gets the cursor with a pointing hand, as used for example on a hyperlink.

Remarks

This corresponds to the pointer CSS cursor. This is how it appears in your browser (hover to see):

PROGRESS

: Cursor

Gets the cursor that indicates progress.

Remarks

This corresponds to the progress CSS cursor. This is how it appears in your browser (hover to see):

ROW_RESIZE

: Cursor

Gets the cursor for resizing rows.

Remarks

This corresponds to the row-resize CSS cursor. This is how it appears in your browser (hover to see):

S_RESIZE

: Cursor

Gets a cursor that indicates that the edge at the south will be moved.

Remarks

Depending on the browser this might just be a vertical resize cursor.

This corresponds to the s-resize CSS cursor. This is how it appears in your browser (hover to see):

SE_RESIZE

: Cursor

Gets a cursor that indicates that edges at the south and east will be moved.

Remarks

Depending on the browser this might just be the diagonal resize cursor for NW to SE resizes.

This corresponds to the se-resize CSS cursor. This is how it appears in your browser (hover to see):

SW_RESIZE

: Cursor

Gets a cursor that indicates that edges at the south and west will be moved.

Remarks

Depending on the browser this might just be the diagonal resize cursor for NE to SW resizes.

This corresponds to the sw-resize CSS cursor. This is how it appears in your browser (hover to see):

TEXT

: Cursor

Gets the text selection cursor.

Remarks

This corresponds to the text CSS cursor. This is how it appears in your browser (hover to see):

VERTICAL_TEXT

: Cursor

Gets the vertical text selection cursor.

Remarks

This corresponds to the vertical-text CSS cursor. This is how it appears in your browser (hover to see):

W_RESIZE

: Cursor

Gets a cursor that indicates that the edge at the west will be moved.

Remarks

Depending on the browser this might just be a horizontal resize cursor.

This corresponds to the w-resize CSS cursor. This is how it appears in your browser (hover to see):

WAIT

: Cursor

Gets the wait cursor.

Remarks

This corresponds to the wait CSS cursor. This is how it appears in your browser (hover to see):

ZOOM_IN

: Cursor

Gets the cursor for zooming in.

Remarks

This corresponds to the zoom-in CSS cursor. This is how it appears in your browser (hover to see):

ZOOM_OUT

: Cursor

Gets the cursor for zooming out.

Remarks

This corresponds to the zoom-out CSS cursor. This is how it appears in your browser (hover to see):