Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

FilterFunction

FilterFunction: (itemLabel: string, filterValue: string) => boolean

A function for filtering the options of a pick list box.

Type declaration

    • (itemLabel: string, filterValue: string): boolean
    • Parameters

      • itemLabel: string

        The label of the currently selected text.

      • filterValue: string

        The value to search for.

      Returns boolean

      true if the item label matches the filter value, or false otherwise.

FilterMatchMode

FilterMatchMode: "startsWith" | "contains" | "endsWith" | "custom"

Available modes for filtering the options of a pick list. When custom is set, a filterFunction must be specified.

ListName

ListName: "source" | "target"

The type for the two lists comprising the pick list, i.e. whether a list contain the source or target items.

OnTransferCallback

OnTransferCallback: (transferData: TransferData) => void

Callback that is invoked when items are transferred from one list to the other. See also PickListCfg.onTransfer.

Type declaration

    • Parameters

      • transferData: TransferData

        Details about the pick list item that was transferred.

      Returns void

TransferType

TransferType: "command" | "dblclick" | "dragdrop"

Indicates how an item was transferred from one list to the other.

  • command: The item was transferred as a result of the user clicking one of the command buttons next to the lists.
  • dblclick: The item was transferred as a result of a double click by the user.
  • dragdrop: The item was transferred as a result of a drag&drop interaction by the user.

Generated using TypeDoc