Class MultiViewerWindowOverlayPropertiesCommand

Base command type for a full writable command, which uses flags to indicate the changed properties

Hierarchy

WritableCommand<MultiViewerWindowOverlayPropertiesState>
- MultiViewerWindowOverlayPropertiesCommand

Index

Constructors

Properties

_properties flag multiViewerId runOrderGroup? windowIndex MaskFlags minimumVersion? rawName

Accessors

Methods

_updateProps serialize updateProps

Constructors

constructor

new MultiViewerWindowOverlayPropertiesCommand(multiviewerId, windowIndex): MultiViewerWindowOverlayPropertiesCommand
Parameters
- multiviewerId: number
- windowIndex: number
Returns MultiViewerWindowOverlayPropertiesCommand
Overrides WritableCommand.constructor
- Defined in src/commands/Settings/MultiViewerWindowOverlayPropertiesCommand.ts:16

Properties

`Protected` _properties

_properties: Partial<MultiViewerWindowOverlayPropertiesState>

flag

flag: number

`Readonly` multiViewerId

multiViewerId: number

`Optional` runOrderGroup

runOrderGroup?: number = 0

Link

ISerializableCommand.runOrderGroup

`Readonly` windowIndex

windowIndex: number

`Static` MaskFlags

MaskFlags: {
borderVisible: number;
labelVisible: number;
} = ...

Type declaration

borderVisible: number
labelVisible: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "CMvO" = 'CMvO'

Accessors

properties

get properties(): Readonly<T>
Returns Readonly<T>
Inherited from WritableCommand.properties
- Defined in src/commands/CommandBase.ts:47

Methods

`Protected` _updateProps

_updateProps(newProps): boolean
Parameters
- newProps: {
  [key: string]: any;
  }
  - [key: string]: any
Returns boolean
Inherited from WritableCommand._updateProps
- Defined in src/commands/CommandBase.ts:75

serialize

serialize(): Buffer
Returns Buffer
Overrides WritableCommand.serialize
- Defined in src/commands/Settings/MultiViewerWindowOverlayPropertiesCommand.ts:23

updateProps

updateProps(newProps): boolean
Update the values of some properties with this command
Parameters
- newProps: Partial<MultiViewerWindowOverlayPropertiesState>
Returns boolean
Inherited from WritableCommand.updateProps
- Defined in src/commands/CommandBase.ts:71

Generated using TypeDoc