Interface ICommand

Describes a viewer command

export
interface: ICommand

Hierarchy

ICommand

Index

Properties

Properties

enabled

enabled: function

Indicates if this command is enabled based on the given application state

memberof: ICommand

Type declaration

- (state: Readonly<IApplicationState>, parameters?: any): boolean
- Parameters
  - state: Readonly<IApplicationState>
  - Optional parameters: any
  Returns boolean

Optional icon

icon: undefined | string

The icon for this command

type: {string}
memberof: ICommand

Optional iconClass

iconClass: undefined | string

invoke

invoke: DispatcherFunc

Invokes the command

type: {DispatcherFunc}
memberof: ICommand

selected

selected: function

Indicates if this command is enabled based on the given application state

memberof: ICommand

Type declaration

- (state: Readonly<IApplicationState>): boolean
- Parameters
  - state: Readonly<IApplicationState>
  Returns boolean

Generated using TypeDoc