Class EquationFunctions

Equation Functions.

Contains methods for all equation functions.

Index

Methods

container offset brac bar annotate scale color frac supSub sup sub touchBox box pad topBar bottomBar matrix lines int sumOf prodOf topComment bottomComment strike topStrike bottomStrike

Methods

container

container(options: EQN_Container): Container
Equation container function
Parameters
- options: EQN_Container
Returns Container
See
EQN_Container for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:3446

offset

offset(options: EQN_Offset): Offset
Equation container function
Parameters
- options: EQN_Offset
Returns Offset
See
EQN_Offset for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:3512

brac

brac(options: EQN_Bracket): BaseAnnotationFunction
Equation bracket function
Parameters
- options: EQN_Bracket
Returns BaseAnnotationFunction
See
EQN_Bracket for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:3555

bar

bar(
options: EQN_Bar,
forceOptions?: Record<string, any>,
): BaseAnnotationFunction
Equation bar function
Parameters
- options: EQN_Bar
- forceOptions: Record<string, any> = {}
Returns BaseAnnotationFunction
See
EQN_Bar for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:3658

annotate

annotate(options: EQN_Annotate): BaseAnnotationFunction
Equation annotate function
Parameters
- options: EQN_Annotate
Returns BaseAnnotationFunction
See
EQN_Annotate for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:3826

scale

scale(options: EQN_Scale): Scale
Equation annotate function
Parameters
- options: EQN_Scale
Returns Scale
See
EQN_Scale for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:3959

color

color(options: EQN_Color): Color
Equation color function
Parameters
- options: EQN_Color
Returns Color
See
EQN_Color for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:3998

frac

frac(options: EQN_Fraction): Fraction
Equation fraction function
Parameters
- options: EQN_Fraction
Returns Fraction
See
EQN_Fraction for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:4037

supSub

supSub(options: EQN_SuperscriptSubscript): BaseAnnotationFunction
Equation super-sub script function
Parameters
- options: EQN_SuperscriptSubscript
Returns BaseAnnotationFunction
See
EQN_SuperscriptSubscript for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:4186

sup

sup(options: EQN_Superscript): BaseAnnotationFunction
Equation superscript function
Parameters
- options: EQN_Superscript
Returns BaseAnnotationFunction
See
EQN_Superscript for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:4256

sub

sub(options: EQN_Subscript): BaseAnnotationFunction
Equation subscript function
Parameters
- options: EQN_Subscript
Returns BaseAnnotationFunction
See
EQN_Subscript for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:4289

touchBox

touchBox(options: EQN_TouchBox): BaseAnnotationFunction
Equation touch box function
Parameters
- options: EQN_TouchBox
Returns BaseAnnotationFunction
See
EQN_TouchBox for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:4321

box

box(options: EQN_Box): BaseAnnotationFunction
Equation box function
Parameters
- options: EQN_Box
Returns BaseAnnotationFunction
See
EQN_Box for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:4387

pad

pad(options: EQN_Pad): BaseAnnotationFunction
Equation pad function
Parameters
- options: EQN_Pad
Returns BaseAnnotationFunction
See
EQN_Pad for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:4460

topBar(options: EQN_Bar): BaseAnnotationFunction
Equation top bar function
Parameters
- options: EQN_Bar
Returns BaseAnnotationFunction
See
EQN_Bar for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:4507

bottomBar

bottomBar(options: EQN_Bar): BaseAnnotationFunction
Equation bottom bar function
Parameters
- options: EQN_Bar
Returns BaseAnnotationFunction
See
EQN_Bar for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:4519

matrix

matrix(options: EQN_Matrix): BaseAnnotationFunction | Matrix
Equation matrix function
Parameters
- options: EQN_Matrix
Returns BaseAnnotationFunction | Matrix
See
EQN_Matrix for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:4531

lines

lines(options: EQN_Lines): Lines
Equation matrix function
Parameters
- options: EQN_Lines
Returns Lines
See
EQN_Matrix for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:4609

int

int(options: EQN_Integral): BaseAnnotationFunction
Equation integral function
Parameters
- options: EQN_Integral
Returns BaseAnnotationFunction
See
EQN_Integral for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:4684

sumOf

sumOf(options: EQN_SumOf): BaseAnnotationFunction
Equation sum of function
Parameters
- options: EQN_SumOf
Returns BaseAnnotationFunction
See
EQN_SumOf for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:4870

prodOf

prodOf(options: EQN_ProdOf): BaseAnnotationFunction
Equation product of function
Parameters
- options: EQN_ProdOf
Returns BaseAnnotationFunction
See
EQN_ProdOf for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:4882

topComment

topComment(...args: any[]): BaseAnnotationFunction
Equation top comment of function
Parameters
- ...args: any[]
Returns BaseAnnotationFunction
See
EQN_Comment for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:5069

bottomComment

bottomComment(...args: any[]): BaseAnnotationFunction
Equation bottom comment of function
Parameters
- ...args: any[]
Returns BaseAnnotationFunction
See
EQN_Comment for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:5136

strike

strike(options: EQN_Strike): BaseAnnotationFunction
Equation strike of function
Parameters
- options: EQN_Strike
Returns BaseAnnotationFunction
See
EQN_Strike for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:5202

topStrike

topStrike(...args: any[]): BaseAnnotationFunction
Equation top strike of function
Parameters
- ...args: any[]
Returns BaseAnnotationFunction
See
EQN_Strike for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:5320

bottomStrike

bottomStrike(...args: any[]): BaseAnnotationFunction
Equation bottom strike of function
Parameters
- ...args: any[]
Returns BaseAnnotationFunction
See
EQN_Strike for description and examples
- Defined in src/js/figure/Equation/EquationFunctions.ts:5358