SheetXL - v0.3.20
    Preparing search index...

    Class CommandGroup

    Default implementation of ICommands.IGroup.

    Implements

    Index

    Constructors

    constructor

    Methods

    activate addCommands addListener createChildGroup dispatchToFocusedCommand findCommandByEvent getActive getAllCommands getCommand getGroup getKey getParent getRoot removeFromParent

    Constructors

    Methods

    • Set the command group to the 'focused group.

      Parameters

      • OptionalgroupKey: string

        The key of the group to activate. If not provided then the current group is activated.

      Returns void

    • Add a collection of commands to the group.

      Parameters

      • commands: readonly ICommand<any, any>[]

        The commands to add.

      • Optionalreplace: boolean

        If true replace the existing commands. If false ignores duplicates. If unspecified a warning will be logged for duplicates.

      Returns void

      Set the commands for the current node.

    • Create a new map to add Commands.

      Parameters

      • target: ITarget | (() => ITarget)

        ICommands.ITarget.

      • when: string

        String description describing the reason for the group. This is presented to the user in the shortcut UI.

      • Optionalreplace: boolean

        If true replace the existing commands. If false ignores duplicates. If unspecified a warning will be logged for duplicates.

      Returns IGroup

    • Parameters

      • e: KeyboardEvent

        The keyboard event to dispatch

      Returns boolean

    • Return a command that matched the keyboard event or null if no command was found.

      Parameters

      • e: KeyboardEvent

        The keyboard event.

      Returns ICommand<any, void>

    • Return the active group.

      Returns IGroup

      This is the group that the dispatch will start from.

    • Returns a list of all commands in the group and all children commands.

      Returns { command: ICommand<any, any>; groupKey: string }[]

      This does not return parent commands.

    • Return a command that matches the key.

      Parameters

      • key: string
      • Optional_ignoreActive: boolean

      Returns ICommand<any, any>

      Search both the current and any child commands groups that are actives.

    • Returns a group for the given when string.

      Parameters

      • key: string

      Returns IGroup

    • Returns the keys associated with the group

      Returns string

    • Returns the parent command group.

      Returns IGroup

      If root then will return return itself.

    • Returns the top most commands group.

      Returns IGroup

      If root then will return return itself.

    • Remove the command group from the parent.

      Returns void

      If this is the root this operation will have no effect

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods