Edit

Share via

NumberExpression class

  • Reference
Package:
adaptive-expressions

Represents a property which is either a float or a string expression which resolves to a float.

Extends

ExpressionProperty<number>

Remarks

String values are always interpreted as an expression, whether it has '=' prefix or not.

Constructors

NumberExpression(number | string | Expression)

Initializes a new instance of the NumberExpression class.

Inherited Properties

expressionText

Getes or sets the expression text to evaluate to get the value.
value

Gets or sets the raw value of the expression property.

Methods

setValue(number | string | Expression)

Set a number value.

Inherited Methods

getValue(object)

Get the value.
toExpression()

This will return the existing expression if the value is non-complex type.
toString()

Convert an expression property to string.
tryGetValue(object)

Try to Get the value.

Constructor Details

NumberExpression(number | string | Expression)

Initializes a new instance of the NumberExpression class.

new NumberExpression(value?: number | string | Expression)

Parameters

value

number | string | Expression

A float number or string expression which resolves to a float number.

Inherited Property Details

expressionText

Getes or sets the expression text to evaluate to get the value.

expressionText: string

Property Value

string

Inherited From ExpressionProperty.expressionText

value

Gets or sets the raw value of the expression property.

value: number

Property Value

number

Inherited From ExpressionProperty.value

Method Details

setValue(number | string | Expression)

Set a number value.

function setValue(value: number | string | Expression)

Parameters

value

number | string | Expression

Value to set.

Inherited Method Details

getValue(object)

Get the value.

function getValue(data: object): number

Parameters

data

object

Data to use for expression binding.

Returns

number

The value.

Remarks

An error will be thrown if value is an invalid expression.

Inherited From ExpressionProperty.getValue

toExpression()

This will return the existing expression if the value is non-complex type.

function toExpression(): Expression

Returns

Expression

The existing expression if the value is non-complex type.

Inherited From ExpressionProperty.toExpression

toString()

Convert an expression property to string.

function toString(): string

Returns

string

The converted string.

Inherited From ExpressionProperty.toString

tryGetValue(object)

Try to Get the value.

function tryGetValue(data: object): { error: Error, value: number }

Parameters

data

object

Data to use for expression binding.

Returns

{ error: Error, value: number }

the value or an error.

Inherited From ExpressionProperty.tryGetValue