I

IInputModeContext

Show Usages
The interface for the context object that is passed to IInputMode instances during install and uninstall and IDragHandler implementations like IPositionHandler and IHandle to provide additional context for the implementations.
ImplementsInheritance Hierarchy

Remarks

Implementations of this interface can carry additional information through their lookup method.

See Also

Developer's Guide

API

ILookup, IInputMode

Members

Show:

Properties

canvasComponent

: CanvasComponent
readonlyabstract
Gets the Canvas that is associated with this context.
readonlyabstract

graph

: IGraph
readonly
Tries to retrieve an IGraph instance from an IInputModeContext.
This will use the ILookup and if this yields nothing, it will use the ILookup of the canvasComponent or finally test if it is a GraphComponent to obtain the graph from.
readonly

hitTestRadius

: number
readonlyabstract
Gets the radius for hit tests and marquee selection tests in world coordinates.

In the default implementations, this property automatically distinguishes between different radii depending on the last interaction event type.

This value already takes the zoom level into account.

readonlyabstract

See Also

Developer's Guide

inputMode

: IInputMode
readonlyabstract
Gets the IInputMode which this context conceptually has been created for.

This can be null if this instance is used outside the context of an IInputMode.

When an IInputMode triggers an event, performs an action or invokes a callback that expects an IInputModeContext, typically that context will provide the invoking mode via this property.

readonlyabstract

zoom

: number
readonlyabstract
Gets the current zoom level that is the ratio of world coordinates to screen pixels.
readonlyabstract

Methods

getDefsId

(defsSupport: ISvgDefsCreator): string
abstract
Adds an element to the defs section of the document, if it has not been added yet.
abstract

Parameters

defsSupport: ISvgDefsCreator
The instance that is used to create and update the element and to query if the element is still referenced

Return Value

string
The id of the element with which it can be referenced using an url reference.

invalidateDisplays

()
Tries to call invalidateDisplays on the graph obtained from the IInputModeContext.
If the graph instance cannot be found, invalidate will be called instead.

lookup

<T> (type: Constructor<T>): T
abstract
Returns an instance that implements the given type or null.
Typically, this method will be called to obtain a different view or aspect of the current instance. This is quite similar to casting or using a super type or interface of this instance, but is not limited to inheritance or compile-time constraints. An instance implementing this method is not required to return non-null implementations for the types, nor does it have to return the same instance any time. Also, it depends on the type and context whether the instance returned stays up to date or needs to be re-obtained for further use.
abstract

Parameters

type: Constructor<T>
the type for which an instance shall be returned

Return Value

T
an instance that is assignable to the type or null

See Also

Developer's Guide

Defined in

ILookup.lookup