Class siModifier

! If you are ever in need of using this class, please PLEASE refactor it. ! Just do it. I did not have the time to do it myself and did not want to break compatibility with the old Margot APIs.

Hierarchy (view full)

unitModifier
- siModifier
  - timeModifier

Index

Constructors

constructor

new siModifier(base, baseModifier?): siModifier
Parameters
- base: string
- OptionalbaseModifier: unitModifier
Returns siModifier
Inherited from unitModifier.constructor
- Defined in lara-framework/Lara-JS/src-api/lara/units/UnitModifier.ts:12

Properties

`Protected` `Static`_unitModifier

_unitModifier: unitModifier = ...

`Static`BASE

BASE: string = ...

`Static`GIGA

GIGA: string = ...

`Static`KILO

KILO: string = ...

`Static`MEGA

MEGA: string = ...

`Static`MICRO

MICRO: string = ...

`Static`MILLI

MILLI: string = ...

`Static`NANO

NANO: string = ...

Methods

checkModifier

checkModifier(modifier, source): void
Parameters
- modifier: string
- source: string
Returns void
Inherited from unitModifier.checkModifier
- Defined in lara-framework/Lara-JS/src-api/lara/units/UnitModifier.ts:59

convert

convert(value, fromModifier, toModifier): number
Parameters
- value: number
- fromModifier: string
- toModifier: string
Returns number
Inherited from unitModifier.convert
- Defined in lara-framework/Lara-JS/src-api/lara/units/UnitModifier.ts:44

getBase

getBase(): string
Returns string
Inherited from unitModifier.getBase
- Defined in lara-framework/Lara-JS/src-api/lara/units/UnitModifier.ts:26

getModifierByName

getModifierByName(name): string
Parameters
- name: string
Returns string
Inherited from unitModifier.getModifierByName
- Defined in lara-framework/Lara-JS/src-api/lara/units/UnitModifier.ts:83

isValid

isValid(modifier): boolean
Parameters
- modifier: string
Returns boolean
Inherited from unitModifier.isValid
- Defined in lara-framework/Lara-JS/src-api/lara/units/UnitModifier.ts:79

newModifier

newModifier(modifier, name, factor): string
Parameters
- modifier: string
- name: string
- factor: number
Returns string
Inherited from unitModifier.newModifier
- Defined in lara-framework/Lara-JS/src-api/lara/units/UnitModifier.ts:30

normalize

normalize(modifier): string
Parameters
- modifier: string
Returns string
Inherited from unitModifier.normalize
- Defined in lara-framework/Lara-JS/src-api/lara/units/UnitModifier.ts:91

values

values(): string[]
Returns string[]
Inherited from unitModifier.values
- Defined in lara-framework/Lara-JS/src-api/lara/units/UnitModifier.ts:87

`Static`checkModifier

checkModifier(modifier, source): void
Parameters
- modifier: string
- source: string
Returns void
- Defined in lara-framework/Lara-JS/src-api/lara/units/SiModifier.ts:26

`Static`convert

convert(value, fromModifier, toModifier): number
Parameters
- value: number
- fromModifier: string
- toModifier: string
Returns number
- Defined in lara-framework/Lara-JS/src-api/lara/units/SiModifier.ts:22

`Static`getModifierByName

getModifierByName(name): string
Parameters
- name: string
Returns string
- Defined in lara-framework/Lara-JS/src-api/lara/units/SiModifier.ts:34

`Static`getUnitModifier

getUnitModifier(): unitModifier
Returns unitModifier
- Defined in lara-framework/Lara-JS/src-api/lara/units/SiModifier.ts:18

`Static`isValid

isValid(modifier): boolean
Parameters
- modifier: string
Returns boolean
- Defined in lara-framework/Lara-JS/src-api/lara/units/SiModifier.ts:30

Class siModifier

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns siModifier

Properties

Protected Static_unitModifier

StaticBASE

StaticGIGA

StaticKILO

StaticMEGA

StaticMICRO

StaticMILLI

StaticNANO

Methods

checkModifier

Parameters

Returns void

convert

Parameters

Returns number

getBase

Returns string

getModifierByName

Parameters

Returns string

isValid

Parameters

Returns boolean

newModifier

Parameters

Returns string

normalize

Parameters

Returns string

values

Returns string[]

StaticcheckModifier

Parameters

Returns void

Staticconvert

Parameters

Returns number

StaticgetModifierByName

Parameters

Returns string

StaticgetUnitModifier

Returns unitModifier

StaticisValid

Parameters

Returns boolean

Settings

On This Page

`Protected` `Static`_unitModifier

`Static`BASE

`Static`GIGA

`Static`KILO

`Static`MEGA

`Static`MICRO

`Static`MILLI

`Static`NANO

`Static`checkModifier

`Static`convert

`Static`getModifierByName

`Static`getUnitModifier

`Static`isValid