XYZT - The vector manipulation class

Type aliases

ArrayFull

ArrayFull<T>: { 0: T } & T[]

Array with at least one item

Type parameters

ArrayFull2

ArrayFull2<T>: { 0: T; 1: T } & T[]

Array with at least two items

Type parameters

IAngleUnit

IAngleUnit: "(rad)" | "rad" | "(deg)" | "deg" | "grad" | "turn"

IAppliableOnTransform

IAppliableOnTransform: { applyOnTransform: ITransformApplyModifierFunction }

Type declaration

applyOnTransform: ITransformApplyModifierFunction

IAppliableOnVector

IAppliableOnVector: { applyOnVector: IVectorApplyModifierFunction }

Type declaration

applyOnVector: IVectorApplyModifierFunction

IAxis

IAxis: "x" | "y" | "z"

IDimensionUnit

IDimensionUnit: "(px)" | "px"

IInversible

IInversible<T>: T & { inverse: any }

Type parameters

ITransformApplyModifier

ITransformApplyModifier: ITransformApplyModifierFunction | IAppliableOnTransform

ITransformApplyModifierFunction

ITransformApplyModifierFunction: (Transform: Transform) => ITransformData

Type declaration

- (Transform: Transform): ITransformData
- Parameters
  - Transform: Transform
  Returns ITransformData

IVector

IVector: IVectorData

IVectorApplyModifier

IVectorApplyModifier: IVectorApplyModifierFunction | IAppliableOnVector

IVectorApplyModifierFunction

IVectorApplyModifierFunction: (vector: Vector) => IVector

Type declaration

- (vector: Vector): IVector
- Parameters
  - vector: Vector
  Returns IVector

Variables

Const AXES

AXES: IAxis[] = ...

Const CSS_FORMAT

CSS_FORMAT: ITransformStyleFormat = ...

Const NEGLIGIBLE_THRESHOLD

NEGLIGIBLE_THRESHOLD: 1e-9 = 0.000000001

Threshold bellow which are decimal numbers so negligible that can be stripped from its main part See tests of stripInfatesimals

Functions

_rotateFromStyle

_rotateFromStyle(cssTransform: string): number | null

- Defined in utils/transform/transformFromStyle/_rotateFromStyle.ts:5
Parameters
- cssTransform: string
Returns number | null

_scaleFromStyle

_scaleFromStyle(cssTransform: string): Vector | null

- Defined in utils/transform/transformFromStyle/_scaleFromStyle.ts:4
Parameters
- cssTransform: string
Returns Vector | null

_transformAngleToStyle

_transformAngleToStyle(styleFormat: Pick<ITransformStyleFormat, "angleUnit" | "fractionDigits">, value: number): string

- Defined in utils/transform/transformToStyle/_transformAngleToStyle.ts:5
Parameters
- styleFormat: Pick<ITransformStyleFormat, "angleUnit" | "fractionDigits">
- value: number
Returns string

_transformDimensionToStyle

_transformDimensionToStyle(styleFormat: Pick<ITransformStyleFormat, "fractionDigits" | "dimensionUnit">, value: number): string

- Defined in utils/transform/transformToStyle/_transformDimensionToStyle.ts:4
Parameters
- styleFormat: Pick<ITransformStyleFormat, "fractionDigits" | "dimensionUnit">
- value: number
Returns string

_transformRotateToStyle

_transformRotateToStyle(styleFormat: ITransformStyleFormat, rotate: Vector): string | null

- Defined in utils/transform/transformToStyle/_transformRotateToStyle.ts:5
Parameters
- styleFormat: ITransformStyleFormat
- rotate: Vector
Returns string | null

_transformScaleToStyle

_transformScaleToStyle(styleFormat: ITransformStyleFormat, scale: Vector): string | null

- Defined in utils/transform/transformToStyle/_transformScaleToStyle.ts:5
Parameters
- styleFormat: ITransformStyleFormat
- scale: Vector
Returns string | null

_transformTranslateToStyle

_transformTranslateToStyle(styleFormat: ITransformStyleFormat, translate: Vector): string | null

- Defined in utils/transform/transformToStyle/_transformTranslateToStyle.ts:5
Parameters
- styleFormat: ITransformStyleFormat
- translate: Vector
Returns string | null

_translateFromStyle

_translateFromStyle(cssTransform: string): Vector | null

- Defined in utils/transform/transformFromStyle/_translateFromStyle.ts:4
Parameters
- cssTransform: string
Returns Vector | null

applyTransformOnElement

applyTransformOnElement(transform: ITransformData, element: Element): void

- Defined in utils/transform/applyTransformOnElement/applyTransformOnElement.ts:5
Parameters
- transform: ITransformData
- element: Element
Returns void

applyTransformOnHtmlElement

applyTransformOnHtmlElement(transform: ITransformData, element: HTMLElement): void

- Defined in utils/transform/applyTransformOnElement/applyTransformOnHtmlElement.ts:6
Parameters
- transform: ITransformData
- element: HTMLElement
Returns void

applyTransformOnSvgElement

applyTransformOnSvgElement(transform: ITransformData, element: SVGGElement): void

- Defined in utils/transform/applyTransformOnElement/applyTransformOnSvgElement.ts:6
Parameters
- transform: ITransformData
- element: SVGGElement
Returns void

convertAngle

convertAngle(from: IAngleUnit, to: IAngleUnit, value: number): number

- Defined in utils/convertAngle.ts:5
Parameters
- from: IAngleUnit
- to: IAngleUnit
- value: number
Returns number

extractValuesFromStyle

extractValuesFromStyle(functionName: string, cssTransform: string): { unit?: string; value: number }[] | null

- Defined in utils/extractValuesFromStyle.ts:1
Parameters
- functionName: string
- cssTransform: string
Returns { unit?: string; value: number }[] | null

fullAngle

fullAngle(unit: IAngleUnit): number

- Defined in utils/fullAngle.ts:3
Parameters
- unit: IAngleUnit
Returns number

minmax

minmax(array: number[]): { max: number; min: number }

- Defined in utils/minmax.ts:4
Count minimum and maximum on large arrays without hitting RangeError: Maximum call stack size exceeded

Parameters
- array: number[]
Returns { max: number; min: number }
- max: number
- min: number

modulo

modulo(dividend: number, divisor: number): number

- Defined in utils/modulo.ts:1
Parameters
- dividend: number
- divisor: number
Returns number

showValue

showValue(fractionDigits: number, value: number): string

- Defined in utils/showValue.ts:1
Parameters
- fractionDigits: number
- value: number
Returns string

showValueWithUnit

showValueWithUnit(unit: IAngleUnit | IDimensionUnit, fractionDigits: number, value: number): string

- Defined in utils/showValueWithUnit.ts:4
Parameters
- unit: IAngleUnit | IDimensionUnit
- fractionDigits: number
- value: number
Returns string

stripInfatesimal

stripInfatesimal(value: number): number

- Defined in utils/stripInfatesimal.ts:4
Parameters
- value: number
Returns number

transformFromStyle

transformFromStyle(cssTransform: string): Transform

- Defined in utils/transform/transformFromStyle/transformFromStyle.ts:11
Converts css style.transform or svg transform to Transform object Note: This function has a bit different philosophy than transformToStyle because it is trying to extract a Transform from the style in any format and you do not need to declare which format is it.

Parameters
- cssTransform: string
Returns Transform

transformToStyle

transformToStyle(styleFormat: ITransformStyleFormat, transform: Transform): string

- Defined in utils/transform/transformToStyle/transformToStyle.ts:7
Parameters
- styleFormat: ITransformStyleFormat
- transform: Transform
Returns string

transformToStyleCss

transformToStyleCss(...args: [transform: Transform]): string

- Defined in utils/transform/transformToStyle/transformToStyleCss.ts:11
Parameters
- Rest ...args: [transform: Transform]
Returns string

transformToStyleSvg

transformToStyleSvg(...args: [transform: Transform]): string

- Defined in utils/transform/transformToStyle/transformToStyleSvg.ts:11
Parameters
- Rest ...args: [transform: Transform]
Returns string

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

ArrayFull

Type parameters

T

ArrayFull2

Type parameters

T

IAngleUnit

IAppliableOnTransform

Type declaration

applyOnTransform: ITransformApplyModifierFunction

IAppliableOnVector

Type declaration

applyOnVector: IVectorApplyModifierFunction

IAxis

IDimensionUnit

IInversible

Type parameters

T

ITransformApplyModifier

ITransformApplyModifierFunction

Type declaration

Parameters

Transform: Transform

Returns ITransformData

IVector

IVectorApplyModifier

IVectorApplyModifierFunction

Type declaration

Parameters

vector: Vector

Returns IVector

Variables

Const AXES

Const CSS_FORMAT

Const NEGLIGIBLE_THRESHOLD

Functions

_rotateFromStyle

Parameters

cssTransform: string

Returns number | null

_scaleFromStyle

Parameters

cssTransform: string

Returns Vector | null

_transformAngleToStyle

Parameters

styleFormat: Pick<ITransformStyleFormat, "angleUnit" | "fractionDigits">

value: number

Returns string

_transformDimensionToStyle

Parameters

styleFormat: Pick<ITransformStyleFormat, "fractionDigits" | "dimensionUnit">

value: number

Returns string

_transformRotateToStyle

Parameters

styleFormat: ITransformStyleFormat

rotate: Vector

Returns string | null

_transformScaleToStyle

Parameters

styleFormat: ITransformStyleFormat

scale: Vector

Returns string | null

_transformTranslateToStyle

Parameters

styleFormat: ITransformStyleFormat

translate: Vector

Returns string | null

_translateFromStyle

Parameters

cssTransform: string

Returns Vector | null