TableEditorInputMode

Gets or sets a property that determines for which types of items should mouse clicks be handled by this mode.

The default is ALL.

conversionfinal

clickablePredicate

: function(TableHitTestResult): boolean

Gets or sets a predicate that is queried to determine whether the item described by the TableHitTestResult can be clicked.

The default value uses the clickableItems and clickableRegions values to determine whether the item should be clicked. If this mode is installed as child mode of a GraphEditorInputMode, it also detects clicks on labels if GraphEditorInputMode allows them.

final

clickableRegions

: StripeSubregionTypes

Gets or sets clicks on which StripeSubregionTypes(s) react to mouse clicks.

This is independent of clickSelectableItems. Default value is HEADER.

conversionfinal

clickInputMode

: ClickInputMode

Gets or sets the clickInputMode.

If the field has not yet been initialized upon first access, a new instance will be assigned. Upon change the onClickInputModeChanged method will be called. If the parent TableEditorInputMode instance is installed as child mode of a GraphEditorInputMode instance, this mode is not used, since all work is delegated to the parent's clickInputMode instance. This implies that all modifications made to the property value have no effect as long as the parent mode is child of a GraphEditorInputMode instance.

By default this input mode has a priority of 0.

final

Property Value

The clickInputMode.

clickSelectableItems

MultiplexingInputMode.controller

Gets or sets a property that determines which types of items should be selectable through mouse clicks.

The default is ALL.

conversionfinal

clickSelectableRegions

: StripeSubregionTypes

Gets or sets clicks on which StripeSubregionTypes(s) should toggle a stripe selection state.

This is independent of clickSelectableItems. By default, only clicks on a stripe HEADER are handled.

conversionfinal

controller

: ConcurrencyController

protectedreadonly

Gets the installed controller.

protectedreadonlyfinal

Defined in

defaultCursor

: Cursor

Gets or sets the cursor to use whenever no child mode prefers a different cursor.

The default is null

conversionfinal

Defined in

MultiplexingInputMode.defaultCursor

deletableItems

MultiplexingInputMode.enabled

Gets or sets a property that determines which types of items may be deleted using the deleteSelection action.

The default is ALL.

conversionfinal

doubleClickablePredicate

: function(TableHitTestResult): boolean

Gets or sets a predicate that is queried to determine whether the item described by the TableHitTestResult can be double-clicked.

The default value uses the clickablePredicate to determine whether the item should be clicked.

final

editLabelPredicate

: function(IModelItem): boolean

Gets or sets a predicate that is queried to determine whether the given label or a label owned by the given owner can be edited.

The default value uses the result of the labelEditableItems property for the given item.

final

enabled

: boolean

Gets or sets the enabled state of this input mode.

Clients can use this property to disable or reenable this instance. This will set the enabled property of the installed controller so a disabled instance should never try to acquire the input mutex.

Defined in

exclusive

: boolean

Gets or sets a value indicating whether this mode will be the only one running when it has the mutex.

The value of this property will be delegated to the exclusive property of the controller.

If this mode is marked as exclusive and has the mutex, all other modes added to the same MultiplexingInputMode will be deactivated. Otherwise, it will always run concurrently with all other modes.

final

Defined in

MultiplexingInputMode.exclusive

installCommandPredicate

: function(Command): boolean

Gets or sets a predicate that is queried by onKeyboardInputModeChanged to determine whether a built-in Command should be installed.

The default value always returns true.

final

keyboardInputMode

: KeyboardInputMode

Gets or sets the keyboardInputMode.

If the field has not yet been initialized upon first access, a new instance will be assigned. Upon change the onKeyboardInputModeChanged method will be called. If the parent TableEditorInputMode instance is installed as child mode of a GraphEditorInputMode instance, this mode is not used, since all work is delegated to the parent's keyboardInputMode instance. This implies that all modifications made to the property value have no effect as long as the parent mode is child of a GraphEditorInputMode instance.

By default this input mode has a priority of 0.

final

Property Value

The keyboardInputMode.

labelEditableItems

MultiplexingInputMode.mutexOwner

Gets or sets a property that determines which types of items may have their labels edited.

The default is ALL which allows for editing the labels of all ILabelOwners, and existing ILabels.

conversionfinal

multiSelectionRecognizer

: function(EventArgs, unknown): boolean

Gets or sets the event recognizer that determines whether a click is deemed a multi-selection gesture.

The default detects the current platform and delegates either to META_IS_DOWN (macOS) or CTRL_IS_DOWN (other platforms). If the TableEditorInputMode instance is installed as a child mode of a GraphEditorInputMode instance, the value of multiSelectionRecognizer is used instead.

final

mutexOwner

: IInputMode

readonly

Gets the IInputMode that currently owns the mutex.

readonlyfinal

Property Value

The IInputMode that currently owns the mutex or null.

Defined in

parentInputModeContext

: IInputModeContext

protectedreadonly

Retrieves the IInputModeContext this mode has been installed in.

The value will be null if this mode is currently not installed. Use createInputModeContext to obtain a context that has this IInputMode as the inputMode.

protectedreadonlyfinal

Defined in

MultiplexingInputMode.parentInputModeContext

priority

: number

Gets the priority of this input mode.

The priority will influence the order in which the modes will be installed into the CanvasComponent. The lower the priority value, the earlier it will be installed. If two modes are using the same priority value, the first one to be registered will be installed earlier.

final

Defined in

MultiplexingInputMode.priority

reparentStripeHandler

: IReparentStripeHandler

Gets or sets the reparentStripeHandler property.

This handler will be delegated to by an implementation of the IReparentStripeHandler interface that this class puts into the childInputModeContextLookup. If the field has not yet been initialized upon first access, a new instance will be assigned. Upon change, the onReparentStripeHandlerChanged method will be called.

final

reparentStripeInputMode

: ReparentStripeInputMode

Gets or sets the ReparentStripeInputMode that is used to change a stripe's position in the table hierarchy.

The mode by default is enabled with a priority of 0. If the field has not yet been initialized upon first access, a new instance will be assigned. Upon change the onReparentStripeInputModeChanged method will be called.

final

resizeStripeInputMode

: ResizeStripeInputMode

Gets or sets the ResizeStripeInputMode that is used to change the size of a stripe interactively.

The mode by default is enabled with a priority of 0. If the field has not yet been initialized upon first access, a new instance will be assigned. Upon change the onResizeStripeInputModeChanged method will be called.

final

selectableItems

MultiplexingInputMode.add

Gets or sets a property that determines which types of items should be selectable at all.

The default is ALL.

conversionfinal

stripeDropInputMode

: StripeDropInputMode

Gets or sets the stripeDropInputMode property that is responsible for handling drag and drop operations of stripes onto the Canvas.

The mode by default is disabled and needs to be enabled to work, first. If the field has not yet been initialized upon first access, a new instance will be assigned. Upon change, onStripeDropInputModeChanged will be called.

By default, this input mode has a priority of 70.

final

stripeSelection

: IStripeSelection

readonly

Gets the selected stripes

readonlyfinal

synchronizeWithGraphSelection

: boolean

Gets or sets a value indicating whether stripeSelection should be synchronized with the graphSelection if this instance is installed as a child of a GraphEditorInputMode instance.

This feature needs to be disabled temporarily if the selection is changed.

By default, this feature is enabled.

final

Methods

add

(mode: IInputMode)

Adds the given mode.

The input modes will be ordered according to their priority: Input modes with lower priority will be installed earlier.

Input modes will run exclusively if the exclusive property of their installed controller is set to true. Otherwise they cannot and will not be deactivated if another IInputMode acquires the mutex.

final

Parameters

mode: IInputMode: The input mode to add to this mode.

Throws

Exception ({ name: 'ArgumentError' }): If the same mode is already added to this instance.

Examples

const multiplexingInputMode = new MultiplexingInputMode()
const waitInputMode = new WaitInputMode()
waitInputMode.priority = 0
multiplexingInputMode.add(waitInputMode)
const moveInputMode = new MoveViewportInputMode()
moveInputMode.priority = 5
multiplexingInputMode.add(moveInputMode)
graphComponent.inputMode = multiplexingInputMode

const mode = new GraphEditorInputMode()
const customInputMode = new CustomInputMode()
customInputMode.priority = 10
mode.add(customInputMode)

Defined in

adjustCursor

()

Adjusts the cursor of the CanvasComponent according to the current input mutex owner or the first mode in the list whose ConcurrencyController returns a non-null preferredCursor.

This method will set defaultCursor as the current cursor if no other preferredCursor has been specified.

Defined in

MultiplexingInputMode.adjustCursor

cancel

()

Cancels all modes.

Defined in

MultiplexingInputMode.cancel

childInputModeContextLookup

(type: Constructor): any

protected

Called by the child context's lookup method.

protected

Parameters

type: Constructor: The type argument passed to lookup.

Return Value

any: The result of the lookup query, or null.

Overrides

MultiplexingInputMode.childInputModeContextLookup

clearSelection

()

Clears the current selection.

click

(tableHitTestResult: TableHitTestResult, evt: ClickEventArgs)

protected

Actually performs the click or tap on the given item.

Before selection the current selection will be cleared, unless the multiSelectionRecognizer is triggered.

protected

Parameters

tableHitTestResult: TableHitTestResult: Information about the item that has been clicked.
evt: ClickEventArgs: The original event arguments for the click. Setting its handled property to true will indicate that the click was handled. By default this happens when the clicked item is either selected or focused.

createInputModeContext

(): IInputModeContext

Yields an IInputModeContext for the child modes of this mode.

This method is called during installation to create a new context for the child modes and can be used by client code to obtain a suitable context object. The parentInputModeContext property is already set when this method is called. lookup calls for the created context will be resolved by this instance's childInputModeContextLookup method.

Return Value

IInputModeContext: A new instance that delegates to the parent's context.

Defined in

MultiplexingInputMode.createInputModeContext

createInputModeEventArgs

(context: IInputModeContext): InputModeEventArgs

protected

Helper method that yields a suitably configured InputModeEventArgs for this input mode.

protected

Parameters

context: IInputModeContext: An input mode context that is available in the InputModeEventArgs.
Can be null in which case a new context for this instance is created automatically.

Return Value

InputModeEventArgs: An input mode event argument that is configured for this instance.

Defined in

MultiplexingInputMode.createInputModeEventArgs

createStripeSelection

(): IStripeSelection

protected

Create a new instance of IStripeSelection the first time property stripeSelection is accessed.

By default, the allowMixedSelection property is false.

protected

Return Value

IStripeSelection: A new IStripeSelection instance.

deleteSelection

()

This method deletes the currently selected stripes.

If the stripeSelection is non-empty, this implementation triggers the deleting-selection event, possibly a number of deleted-item events, and a final deleteSelection event.

deleteStripe

(stripe: IStripe)

Deletes a single stripe.

Parameters

stripe: IStripe: The stripe to delete.

doubleClick

(tableHitTestResult: TableHitTestResult, evt: ClickEventArgs)

protected

Actually performs a double click on the given item.

By default, this will start label editing if allowEditLabelOnDoubleClick is true

protected

Parameters

tableHitTestResult: TableHitTestResult: The item that has been double-clicked.
evt: ClickEventArgs: The original event arguments for the click. Setting its handled property to true will indicate that the double click was handled and events on other items in the same location are no longer raised.

editLabelOnDoubleClick

(item: IModelItem): boolean

protected

Starts label editing by executing EDIT_LABEL.

The method should return whether the request was satisfied.

protected

Parameters

item: IModelItem: The item whose label or the label itself that should be edited upon the double click gesture.

Return Value

boolean: true iff the request was handled.

findStripe

(

location: Point

stripeTypes: StripeTypes

subregionTypes: StripeSubregionTypes

filter?: function(StripeSubregion): boolean

): StripeSubregion

Used as a callback to find the items underneath a certain point.

Parameters

location: Point: The location to test.
stripeTypes: StripeTypes: An enumeration value of StripeTypes to specify the stripe type.
subregionTypes: StripeSubregionTypes: An enumeration value of StripeSubregionTypes to further restrict the stripe region.
filter?: function(StripeSubregion): boolean: Additional predicate to further restrict the hit test results.

Return Value

StripeSubregion: The stripe subregions that have been found for the location or null.

findStripes

(

location: Point

stripeTypes: StripeTypes

subregionTypes: StripeSubregionTypes

filter?: function(StripeSubregion): boolean

): IEnumerable<StripeSubregion>

Used as a callback to find the items underneath a certain point.

Parameters

location: Point: The location to test.
stripeTypes: StripeTypes: An enumeration value of StripeTypes to specify the stripe type.
subregionTypes: StripeSubregionTypes: An enumeration value of StripeSubregionTypes to further restrict the stripe region.
filter?: function(StripeSubregion): boolean: Additional predicate to further restrict the hit test results.

Return Value

IEnumerable<StripeSubregion>: The stripe subregions that have been found for the location.

getSortedModes

(): IList<IInputMode>

Returns a list of all modes managed by this instance sorted by their priority.

final

Return Value

IList<IInputMode>: A list of the modes.

Defined in

MultiplexingInputMode.getSortedModes

initialize

()

protected

Performs one-time initialization of this instance.

This method should not be invoked by subclasses. This will be done automatically upon first installation of this mode.

This code will be executed only once per instance. The parentInputModeContext property will be null when this code is executed. This method should not be used to install this mode into a specific canvas. Subclasses should always call base.Initialize() first.

protected

Overrides

MultiplexingInputMode.initialize

insertChild

(

owner: IStripe

index: number

size?: number

): IStripe

Inserts a new stripe as child of owner

This method automatically resizes the table node and moves all content in neighboring stripes accordingly. The stripe is created with an initial size and otherwise the default settings of the table where owner belongs to. If size is entered as 0, the owner's default size is used.

Parameters

owner: IStripe: The parent of the new stripe.
index: number: The index where to insert the new stripe.
size?: number: The initial size of the stripe.

Return Value

IStripe: A new stripe at the given index unless owner is not associated with a table.

install

(context: IInputModeContext, controller: ConcurrencyController)

Installs this mode into the given context that is provided by the canvas.

In general a mode can only be installed into a single canvas at all times.

This method is called to initialize this instance. Implement this method to register the corresponding event handlers for the various input events this mode will listen to.

When this instance gets uninstalled from the context the same context instance will be passed to it.

Implementations may hold a reference to the context instance and use it while installed.

Parameters

context: IInputModeContext: The context that this instance shall be installed into. The same instance will be passed to this instance during uninstall. A reference to the context may be kept and queried while the mode is installed.
controller: ConcurrencyController: The ConcurrencyController for this mode.

Overrides

MultiplexingInputMode.install

invalidate

()

protected

Invalidates the canvas this mode is currently installed in.

protected

Defined in

MultiplexingInputMode.invalidate

onClickInputModeChanged

(oldMode: ClickInputMode, newMode: ClickInputMode)

protected

Called when the clickInputMode property value changes and after initialization of the field.

protected

Parameters

oldMode: ClickInputMode: the old value, which may be null the first time
newMode: ClickInputMode: the new value

onClickInputModeClicked

(evt: ClickEventArgs, sender: any)

protected

Called once clickInputMode triggers the clicked event with clickCount 1 and pointerType MOUSE.

protected

Parameters

evt: ClickEventArgs: The ClickEventArgs of the event.
sender: any: The sender of the event.

onClickInputModeDoubleClicked

(evt: ClickEventArgs, sender: any)

protected

Called once clickInputMode triggers the clicked event with clickCount 2 and pointerType MOUSE.

protected

Parameters

evt: ClickEventArgs: The ClickEventArgs of the event.
sender: any: The sender of the event.

onConcurrencyControllerActivated

()

protected

Called after the active property of the installed ConcurrencyController has been set to true.

This implementation reenables previously disabled concurrent child modes.

protected

Defined in

MultiplexingInputMode.onConcurrencyControllerActivated

onConcurrencyControllerDeactivated

()

protected

Called after the active property of the installed ConcurrencyController has been set to false.

This implementation sets the preferredCursor property to null and releases the mutex if the mutex is currently owned by this instance. Also, all concurrent child modes will be disabled.

protected

Defined in

MultiplexingInputMode.onConcurrencyControllerDeactivated

onDeletedItem

(evt: InputModeItemEventArgs<IModelItem>)

protected

Raises the deleted-item event.

protectedfinal

Parameters

evt: InputModeItemEventArgs<IModelItem>: The instance containing the event data.

onDeletedSelection

(evt: SelectionEventArgs<IStripe>)

protected

Raises the deleted-selection event.

protected

Parameters

evt: SelectionEventArgs<IStripe>: The SelectionEventArgs<T> instance containing the event data.

onDeletingSelection

(evt: SelectionEventArgs<IStripe>)

protected

Raises the deleting-selection event.

protected

Parameters

evt: SelectionEventArgs<IStripe>: The SelectionEventArgs<T> instance containing the event data.

onItemClicked

protected

Raises the item-clicked event.

This implementation will stop the event propagation as soon as an event handler has set the handled property to true.

protected

Parameters

evt: TableItemClickedEventArgs<IModelItem>: The ItemClickedEventArgs<T> instance that contains the item that has been clicked.

onItemDoubleClicked

protected

Raises the item-double-clicked event.

This implementation will stop the event propagation as soon as an event handler has set the handled property to true.

protected

Parameters

evt: TableItemClickedEventArgs<IModelItem>: The TableItemClickedEventArgs<T> instance that contains the item that has been double-clicked.

onItemLeftClicked

protected

Raises the item-left-clicked event.

This implementation will stop the event propagation as soon as an event handler has set the handled property to true.

protected

Parameters

evt: TableItemClickedEventArgs<IModelItem>: The TableItemClickedEventArgs<T> instance that contains the item that has been clicked.

onItemLeftDoubleClicked

protected

Raises the item-left-double-clicked event.

This implementation will stop the event propagation as soon as an event handler has set the handled property to true.

protected

Parameters

evt: TableItemClickedEventArgs<IModelItem>: The TableItemClickedEventArgs<T> instance that contains the item that has been double clicked.

onItemRightClicked

protected

Raises the item-right-clicked event.

This implementation will stop the event propagation as soon as an event handler has set the handled property to true.

protected

Parameters

evt: TableItemClickedEventArgs<IModelItem>: The ItemClickedEventArgs<T> instance that contains the item that has been clicked.

onItemRightDoubleClicked

MultiplexingInputMode.remove

protected

Raises the item-right-double-clicked event.

This implementation will stop the event propagation as soon as an event handler has set the handled property to true.

protected

Parameters

evt: TableItemClickedEventArgs<IModelItem>: The TableItemClickedEventArgs<T> instance that contains the item that has been double clicked.

onKeyboardInputModeChanged

(oldMode: KeyboardInputMode, newMode: KeyboardInputMode)

protected

Called when the keyboardInputMode changed.

protected

Parameters

oldMode: KeyboardInputMode: The old keyboardInputMode.
newMode: KeyboardInputMode: The new keyboardInputMode.

onReparentStripeHandlerChanged

(oldHandler: IReparentStripeHandler, newHandler: IReparentStripeHandler)

protected

Called when the reparentStripeHandler property value changes and after initialization of the field.

protected

Parameters

oldHandler: IReparentStripeHandler: the old value, which may be null the first time
newHandler: IReparentStripeHandler: the new value

onReparentStripeInputModeChanged

(oldHandler: ReparentStripeInputMode, newHandler: ReparentStripeInputMode)

protected

Called when the reparentStripeInputMode property value changes and after initialization of the field.

protected

Parameters

oldHandler: ReparentStripeInputMode: the old value, which may be null the first time
newHandler: ReparentStripeInputMode: the new value

onResizeStripeInputModeChanged

(oldMode: ResizeStripeInputMode, newMode: ResizeStripeInputMode)

protected

Called when the resizeStripeInputMode property value changes and after initialization of the field.

protected

Parameters

oldMode: ResizeStripeInputMode: the old value, which may be null the first time
newMode: ResizeStripeInputMode: the new value

onStripeDropInputModeChanged

(oldMode: StripeDropInputMode, newMode: StripeDropInputMode)

protected

Called when the stripeDropInputMode property value changes and after initialization of the field.

protected

Parameters

oldMode: StripeDropInputMode: the old value, which may be null the first time
newMode: StripeDropInputMode: the new value

remove

(mode: IInputMode)

Removes the given mode from this compound mode.

final

Parameters

mode: IInputMode: The mode to remove.

Defined in

selectAll

()

Clears the current selection and selects all stripes in all table instances.

By default, this method will be called in response to a Ctrl-A-key press recognized by keyboardInputMode.

subModePriorityChanged

()

protected

Called when the priority of an installed sub mode has changed.

This implementation uninstalls all sub modes and then re-installs them according to their new priorities.

protectedfinal

Defined in

MultiplexingInputMode.subModePriorityChanged

tryStop

(): boolean

Tries to stop all modes.

Return Value

boolean: true if the editing process was successfully stopped, or if there was no edit in progress to stop; otherwise, false.

Defined in

MultiplexingInputMode.tryStop

uninstall

(context: IInputModeContext)

Uninstalls this mode from the given context.

This code should clean up all changes made to the canvas in the install method. After a mode has been uninstalled it can be installed again into the same or another canvas.

Parameters

context: IInputModeContext: The context to deregister from. This is the same instance that had been passed to install during installation.

Overrides

MultiplexingInputMode.uninstall

Events

'deleted-item'

: InputModeItemEventArgs<IModelItem>

Occurs when an item has been deleted interactively by this mode.

Properties of

InputModeItemEventArgs<IModelItem>

context: IInputModeContext: Gets the context for the current event.
item: TModelItem: Gets the item which has been created or changed.

'deleted-selection'

: SelectionEventArgs<IStripe>

Occurs after all selected items have been removed in deleteSelection.

Properties of

SelectionEventArgs<IStripe>

context: IInputModeContext: Gets the context for the current event.
selection: IObservableCollection<T>: Gets the selection these event arguments refer to.

'deleting-selection'

: SelectionEventArgs<IStripe>

Occurs just before the deleteSelection method starts its work and will be followed by any number of deleted-item events and finalized by a deleted-selection event.

Properties of

SelectionEventArgs<IStripe>

context: IInputModeContext: Gets the context for the current event.
selection: IObservableCollection<T>: Gets the selection these event arguments refer to.

'item-clicked'

Occurs when an item has been clicked or tapped.

If one of the event handlers sets the handled property to true the event will not be propagated anymore.

Button-specific and input type specific events (item-left-clicked and item-right-clicked) will be raised before this event. If one of those is marked handled this event will not be raised anymore.

Properties of

altKey: boolean: Gets a value indicating whether the alt modifier was pressed at the time of the click.
clickCount: number: Gets the number of clicks associated with this event.
context: IInputModeContext: Gets the context for the current event.
ctrlKey: boolean: Gets a value indicating whether the control modifier was pressed at the time of the click.
handled: boolean writable: Gets or sets a value indicating whether this instance has been handled.
item: T: Gets the item that is the subject of the event.
location: Point: Gets the location of the click.
metaKey: boolean: Gets a value indicating whether the meta modifier was pressed at the time of the click.
modifiers: ModifierKeys: Gets the state of the modifiers at the time of the click.
originalEventArgs: PointerEventArgs: Gets the pointer event args that caused this event.
pointerButtons: PointerButtons: Gets the PointerButtons that have changed for this event.
pointerType: PointerType: Gets the type of the pointer that was the source of this event.
region: StripeSubregion: The specific region on a stripe where the click has occurred.
shiftKey: boolean: Gets a value indicating whether the shift modifier was pressed at the time of the click.
tableNode: INode: The table node where item is associated.

'item-double-clicked'

Occurs when an item has been double-clicked or double-tapped.

If one of the event handlers sets the handled property to true the event will not be propagated anymore.

Depending on the value of the clickReportingPolicy property of clickInputMode this event may be preceded by no, one, or two item-clicked events (as well as the corresponding button-specific event).

Button-specific and input-type specific events (item-left-double-clicked and item-right-double-clicked) will be raised before this event. If one of those is marked handled this event will not be raised anymore.

Properties of

altKey: boolean: Gets a value indicating whether the alt modifier was pressed at the time of the click.
clickCount: number: Gets the number of clicks associated with this event.
context: IInputModeContext: Gets the context for the current event.
ctrlKey: boolean: Gets a value indicating whether the control modifier was pressed at the time of the click.
handled: boolean writable: Gets or sets a value indicating whether this instance has been handled.
item: T: Gets the item that is the subject of the event.
location: Point: Gets the location of the click.
metaKey: boolean: Gets a value indicating whether the meta modifier was pressed at the time of the click.
modifiers: ModifierKeys: Gets the state of the modifiers at the time of the click.
originalEventArgs: PointerEventArgs: Gets the pointer event args that caused this event.
pointerButtons: PointerButtons: Gets the PointerButtons that have changed for this event.
pointerType: PointerType: Gets the type of the pointer that was the source of this event.
region: StripeSubregion: The specific region on a stripe where the click has occurred.
shiftKey: boolean: Gets a value indicating whether the shift modifier was pressed at the time of the click.
tableNode: INode: The table node where item is associated.

'item-left-clicked'

Occurs when an item has been left clicked.

This event will be raised before the item-clicked event. If one of the event handlers sets the handled property to true the event will not be propagated anymore. This also means that the item-clicked event will not be raised in that case.

Properties of

altKey: boolean: Gets a value indicating whether the alt modifier was pressed at the time of the click.
clickCount: number: Gets the number of clicks associated with this event.
context: IInputModeContext: Gets the context for the current event.
ctrlKey: boolean: Gets a value indicating whether the control modifier was pressed at the time of the click.
handled: boolean writable: Gets or sets a value indicating whether this instance has been handled.
item: T: Gets the item that is the subject of the event.
location: Point: Gets the location of the click.
metaKey: boolean: Gets a value indicating whether the meta modifier was pressed at the time of the click.
modifiers: ModifierKeys: Gets the state of the modifiers at the time of the click.
originalEventArgs: PointerEventArgs: Gets the pointer event args that caused this event.
pointerButtons: PointerButtons: Gets the PointerButtons that have changed for this event.
pointerType: PointerType: Gets the type of the pointer that was the source of this event.
region: StripeSubregion: The specific region on a stripe where the click has occurred.
shiftKey: boolean: Gets a value indicating whether the shift modifier was pressed at the time of the click.
tableNode: INode: The table node where item is associated.

'item-left-double-clicked'

Occurs when an item has been left double clicked.

This event will be raised before the item-double-clicked event. If one of the event handlers sets the handled property to true the event will not be propagated anymore. This also means that the item-double-clicked event will not be raised in that case.

Properties of

altKey: boolean: Gets a value indicating whether the alt modifier was pressed at the time of the click.
clickCount: number: Gets the number of clicks associated with this event.
context: IInputModeContext: Gets the context for the current event.
ctrlKey: boolean: Gets a value indicating whether the control modifier was pressed at the time of the click.
handled: boolean writable: Gets or sets a value indicating whether this instance has been handled.
item: T: Gets the item that is the subject of the event.
location: Point: Gets the location of the click.
metaKey: boolean: Gets a value indicating whether the meta modifier was pressed at the time of the click.
modifiers: ModifierKeys: Gets the state of the modifiers at the time of the click.
originalEventArgs: PointerEventArgs: Gets the pointer event args that caused this event.
pointerButtons: PointerButtons: Gets the PointerButtons that have changed for this event.
pointerType: PointerType: Gets the type of the pointer that was the source of this event.
region: StripeSubregion: The specific region on a stripe where the click has occurred.
shiftKey: boolean: Gets a value indicating whether the shift modifier was pressed at the time of the click.
tableNode: INode: The table node where item is associated.

'item-right-clicked'

Occurs when an item has been right clicked.

Properties of

altKey: boolean: Gets a value indicating whether the alt modifier was pressed at the time of the click.
clickCount: number: Gets the number of clicks associated with this event.
context: IInputModeContext: Gets the context for the current event.
ctrlKey: boolean: Gets a value indicating whether the control modifier was pressed at the time of the click.
handled: boolean writable: Gets or sets a value indicating whether this instance has been handled.
item: T: Gets the item that is the subject of the event.
location: Point: Gets the location of the click.
metaKey: boolean: Gets a value indicating whether the meta modifier was pressed at the time of the click.
modifiers: ModifierKeys: Gets the state of the modifiers at the time of the click.
originalEventArgs: PointerEventArgs: Gets the pointer event args that caused this event.
pointerButtons: PointerButtons: Gets the PointerButtons that have changed for this event.
pointerType: PointerType: Gets the type of the pointer that was the source of this event.
region: StripeSubregion: The specific region on a stripe where the click has occurred.
shiftKey: boolean: Gets a value indicating whether the shift modifier was pressed at the time of the click.
tableNode: INode: The table node where item is associated.

'item-right-double-clicked'

Occurs when an item has been right double clicked.

Properties of