Home > @i2analyze/notebook-sdk > commands > ICommandInvocationContext

commands.ICommandInvocationContext interface

Context that describes where and how a command was triggered.

Signature:

interface ICommandInvocationContext 

Introduced: version 1.10

Remarks

This context is mixed into the payload that every command receives. Its members are populated when the command is triggered from a position on the chart, such as when a pop-up (right-click) menu is opened. They are undefined when the command is triggered without a positional origin, for example from a ribbon or programmatically.

Properties

Property	Modifiers	Type	Description
modifierKeys?	readonly	IModifierKeys	(Optional) Gets the state of the keyboard modifier keys at the point at which the command was triggered.
triggerPosition?	readonly	visual.IPosition	(Optional) Gets the position on the chart at which the command was triggered, in chart coordinates.