Class ColorGeneratorCommand

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

Hierarchy

WritableCommand<ColorGeneratorState>
- ColorGeneratorCommand

Index

Constructors

Properties

_properties flag index runOrderGroup? MaskFlags minimumVersion? rawName

Accessors

Methods

_updateProps serialize updateProps

Constructors

constructor

new ColorGeneratorCommand(index): ColorGeneratorCommand
Parameters
- index: number
Returns ColorGeneratorCommand
Overrides WritableCommand.constructor
- Defined in src/commands/ColorGeneratorCommand.ts:15

Properties

`Protected` _properties

_properties: Partial<ColorGeneratorState>

flag

flag: number

`Readonly` index

index: number

`Optional` runOrderGroup

runOrderGroup?: number = 0

Link

ISerializableCommand.runOrderGroup

`Static` MaskFlags

MaskFlags: {
    hue: number;
    luma: number;
    saturation: number;
} = ...

Type declaration

hue: number
luma: number
saturation: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "CClV" = 'CClV'

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/ColorGeneratorCommand.ts:21

updateProps

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

Generated using TypeDoc