Class GroupEditor

Editor of a Group. Provides methods to add, remove and overwrite units.

Hierarchy

GroupEditor

Index

Methods

Methods

add

add(...units: (Unit | FlexibleUnit)[]): void

- Defined in GroupEditor.ts:37
Adds the given units to the related group. Units having the same default notation (the notation that gets returned on calling unit.toString()) are overwritten.

Parameters
- Rest ...units: (Unit | FlexibleUnit)[]
  
  units to add
Returns void

remove

remove(...units: string[]): void

- Defined in GroupEditor.ts:65
Removes the given units from the related group. Only a single notation per unit is required.

Parameters
- Rest ...units: string[]
  
  units to remove
Returns void

select

select(...units: string[]): void

- Defined in GroupEditor.ts:23
Removes any unit except the given ones.

Parameters
- Rest ...units: string[]
  
  the units that shouldn't get removed
Returns void

Generated using TypeDoc