Class StypNumericStruct<TSelf, TUnit>`Abstract`

Base implementation of structured numeric CSS property value.

Type Parameters

TSelf extends StypNumericStruct<TSelf, TUnit>

A type of itself.
TUnit extends string

Allowed unit type.

Hierarchy

StypValueStruct<TSelf>
- StypNumericStruct

Index

Constructors

constructor

new StypNumericStruct<TSelf, TUnit>(opts): StypNumericStruct<TSelf, TUnit>
Type Parameters
- TSelf extends StypNumericStruct<TSelf, TUnit, TSelf>
- TUnit extends string
Parameters
- opts: StypDimension.Opts<TUnit>
Returns StypNumericStruct<TSelf, TUnit>
Overrides StypValueStruct.constructor
- Defined in frontmeans/style-producer/src/value/numeric/numeric.ts:37

Properties

`Readonly` dim

dim: Kind<TUnit>

`Readonly` priority

priority: number

CSS property value priority.

The value Important and above means the property is !important. Everything else means normal priority.

The property value with higher priority number takes precedence over the one with lower one.

`Abstract` type

type: 0 | "dimension" | "calc"

A type of structured numeric CSS property value.

Methods

`Abstract` add

add(addendum): StypNumeric<TUnit, StypZero<TUnit>>
Parameters
- addendum: StypNumeric<TUnit, StypZero<TUnit>>
Returns StypNumeric<TUnit, StypZero<TUnit>>
- Defined in frontmeans/style-producer/src/value/numeric/numeric.ts:57
add(addendum, unit): StypNumeric<TUnit, StypZero<TUnit>>
Parameters
- addendum: number
- unit: TUnit
Returns StypNumeric<TUnit, StypZero<TUnit>>
- Defined in frontmeans/style-producer/src/value/numeric/numeric.ts:59

by

by(source): StypNumeric<TUnit, StypZero<TUnit>>
Maps the given CSS property value to the value of this one's type. Defaults to this value if mapping is not possible.

This method allows to use an structured value instance as CSS property mapping.
Parameters
- source: StypValue
  
  A raw property value that should be converted.
Returns StypNumeric<TUnit, StypZero<TUnit>>
Mapped property value.
Overrides StypValueStruct.by
- Defined in frontmeans/style-producer/src/value/numeric/numeric.ts:71

`Abstract` div

div(divisor): StypNumeric<TUnit, StypZero<TUnit>>
Parameters
- divisor: number
Returns StypNumeric<TUnit, StypZero<TUnit>>
- Defined in frontmeans/style-producer/src/value/numeric/numeric.ts:67

important

important(): TSelf
Creates !important variant of this value.

Returns TSelf
Either a new value equal to this one but having priority equal to Important, or this one if already the case.
Inherited from StypValueStruct.important
- Defined in frontmeans/style-producer/src/value/value.ts:74

`Abstract` is

is(other): boolean
Checks whether this value equals to CSS property value.
Parameters
- other: StypValue
  
  CSS property value to compare with.
Returns boolean
Inherited from StypValueStruct.is
- Defined in frontmeans/style-producer/src/value/value.ts:56

`Abstract` mul

mul(multiplier): StypNumeric<TUnit, StypZero<TUnit>>
Parameters
- multiplier: number
Returns StypNumeric<TUnit, StypZero<TUnit>>
- Defined in frontmeans/style-producer/src/value/numeric/numeric.ts:65

`Abstract` negate

negate(): StypNumeric<TUnit, StypZero<TUnit>>
Returns StypNumeric<TUnit, StypZero<TUnit>>
- Defined in frontmeans/style-producer/src/value/numeric/numeric.ts:69

`Abstract` prioritize

prioritize(priority): TSelf
Creates structured CSS value with the given priority.
Parameters
- priority: number
  
  New priority.
Returns TSelf
Either a new value equal to this one but having the given priority, or this one if priority did not change.
Inherited from StypValueStruct.prioritize
- Defined in frontmeans/style-producer/src/value/value.ts:66

`Abstract` sub

sub(subtrahend): StypNumeric<TUnit, StypZero<TUnit>>
Parameters
- subtrahend: StypNumeric<TUnit, StypZero<TUnit>>
Returns StypNumeric<TUnit, StypZero<TUnit>>
- Defined in frontmeans/style-producer/src/value/numeric/numeric.ts:61
sub(subtrahend, unit): StypNumeric<TUnit, StypZero<TUnit>>
Parameters
- subtrahend: number
- unit: TUnit
Returns StypNumeric<TUnit, StypZero<TUnit>>
- Defined in frontmeans/style-producer/src/value/numeric/numeric.ts:63

`Abstract` toDim

toDim<TDimUnit>(dim): undefined | StypNumeric<TDimUnit, StypZero<TDimUnit>>
Tries to converts this numeric value to another dimension.

Does not actually construct a value in another dimension, as long as dimension unit supported by both dimensions.
Type Parameters
- TDimUnit extends string
  
  A unit type allowed in target dimension.
Parameters
- dim: Kind<TDimUnit>
  
  Target dimension.
Returns undefined | StypNumeric<TDimUnit, StypZero<TDimUnit>>
Either a value in dimension compatible with dim, or undefined if this value's unit is not supported by dim.
- Defined in frontmeans/style-producer/src/value/numeric/numeric.ts:53

`Abstract` toFormula

toFormula(): string
Returns a textual representation of this value to be used within CSS calc() function.

Returns string
CSS value text without !important or calc().
- Defined in frontmeans/style-producer/src/value/numeric/numeric.ts:80

toString

toString(): string
Returns textual representation of this value.

Textual representation never contains an !important suffix.

Returns string
A textual representation of this value to use as CSS property value.
Overrides StypValueStruct.toString
- Defined in frontmeans/style-producer/src/value/numeric/numeric.ts:82

usual

usual(): TSelf
Creates usual (not !important) variant of this value.

Returns TSelf
Either a new value equal to this one but having priority equal to Usual, or this one if already the case.
Inherited from StypValueStruct.usual
- Defined in frontmeans/style-producer/src/value/value.ts:84

Class StypNumericStruct<TSelf, TUnit>Abstract

Type Parameters

TSelf extends StypNumericStruct<TSelf, TUnit>

TUnit extends string

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

TSelf extends StypNumericStruct<TSelf, TUnit, TSelf>

TUnit extends string

Parameters

opts: StypDimension.Opts<TUnit>

Returns StypNumericStruct<TSelf, TUnit>

Properties

Readonly dim

Readonly priority

Abstract type

Methods

Abstract add

Parameters

addendum: StypNumeric<TUnit, StypZero<TUnit>>

Returns StypNumeric<TUnit, StypZero<TUnit>>

Parameters

addendum: number

unit: TUnit

Returns StypNumeric<TUnit, StypZero<TUnit>>

by

Parameters

source: StypValue

Returns StypNumeric<TUnit, StypZero<TUnit>>

Abstract div

Parameters

divisor: number

Returns StypNumeric<TUnit, StypZero<TUnit>>

important

Returns TSelf

Abstract is

Parameters

other: StypValue

Returns boolean

Abstract mul

Parameters

multiplier: number

Returns StypNumeric<TUnit, StypZero<TUnit>>

Abstract negate

Returns StypNumeric<TUnit, StypZero<TUnit>>

Abstract prioritize

Parameters

priority: number

Returns TSelf

Abstract sub

Parameters

subtrahend: StypNumeric<TUnit, StypZero<TUnit>>

Returns StypNumeric<TUnit, StypZero<TUnit>>

Parameters

subtrahend: number

unit: TUnit

Returns StypNumeric<TUnit, StypZero<TUnit>>

Abstract toDim

Type Parameters

TDimUnit extends string

Parameters

dim: Kind<TDimUnit>

Returns undefined | StypNumeric<TDimUnit, StypZero<TDimUnit>>

Abstract toFormula

Returns string

toString

Returns string

usual

Returns TSelf

Settings

Member Visibility

Theme

On This Page

Class StypNumericStruct<TSelf, TUnit>`Abstract`

`Readonly` dim

`Readonly` priority

`Abstract` type

`Abstract` add

`Abstract` div

`Abstract` is

`Abstract` mul

`Abstract` negate

`Abstract` prioritize

`Abstract` sub

`Abstract` toDim

`Abstract` toFormula