Enumeration LookupKey

Enumeration Members

String Number Boolean Date DateTime LocalDate Capitalize Uppercase Lowercase Integer Currency Percentage Percentage100 ShortDate AbbrevDate LongDate AbbrevDOWDate LongDOWDate TimeOfDay TimeOfDayHMS YesNoBoolean TotalDays Milliseconds Seconds Minutes CaseInsensitive

Enumeration Members

String

String: "String"
Label Value
Native value typeof value === 'string'
Lookup Key "String"
IDataTypeIdentifier StringDataTypeIdentifier
IDataTypeFormatter StringFormatter
IDataTypeConverter none
IDataTypeComparer default

Group

Native Data Type

Remarks

This is used when no Lookup Key is supplied.

Number

Number: "Number"
Label Value
Native value typeof value === 'number'
Lookup Key "Number"
IDataTypeIdentifier NumberDataTypeIdentifier
IDataTypeFormatter NumberFormatter
IDataTypeConverter none
IDataTypeComparer default

Group

Native Data Type

Remarks

This is used when no Lookup Key is supplied.

Boolean

Boolean: "Boolean"
Label Value
Native value typeof value === 'boolean'
Lookup Key "Boolean"
IDataTypeIdentifier BooleanDataTypeIdentifier
IDataTypeFormatter BooleanFormatter
IDataTypeConverter none
IDataTypeComparer BooleanDataTypeComparer, returns only Equal and NotEqual

Group

Native Data Type

Remarks

This is used when no Lookup Key is supplied. If used, BooleanFormatter needs your configuration to know the supported cultures associated values for "true" and "false"

Date

Date: "Date"
Label Value
Native value value instanceof Date
Lookup Key "Date"
IDataTypeIdentifier DateDataTypeIdentifier
IDataTypeFormatter DateFormatter
IDataTypeConverter UTCDateOnlyConverter
IDataTypeComparer default

Group

Native Data Type

Remarks

Just the date part of a Date object. Assumes UTC. This is used when no Lookup Key is supplied because its a much more common case to use just dates.

DateTime

DateTime: "DateTime"
Label Value
Native value value instanceof Date
Lookup Key "DateTime"
IDataTypeIdentifier none
IDataTypeFormatter DateTimeFormatter
IDataTypeConverter DateTimeConverter
IDataTypeComparer default

Group

Native Data Type

LocalDate

LocalDate: "LocalDate"
Label Value
Native value value instanceof Date
Lookup Key "LocalDate"
IDataTypeIdentifier none
IDataTypeFormatter DateFormatter
IDataTypeConverter LocalDateOnlyConverter
IDataTypeComparer default

Group

Native Data Type

Remarks

For when the Date is not in UTC.

Capitalize

Capitalize: "Capitalize"
Label Value
Native value typeof value === 'string'
Lookup Key "Capitalize"
IDataTypeIdentifier none
IDataTypeFormatter CapitalizeStringFormatter
IDataTypeConverter none
IDataTypeComparer default

Group

Formatter

Remarks

First letter of a string is converted to uppercase.

Uppercase

Uppercase: "Uppercase"
Label Value
Native value typeof value === 'string'
Lookup Key "Uppercase"
IDataTypeIdentifier none
IDataTypeFormatter UppercaseStringFormatter
IDataTypeConverter none
IDataTypeComparer default

Group

Formatter

Remarks

String is converted to uppercase.

Lowercase

Lowercase: "Lowercase"
Label Value
Native value typeof value === 'string'
Lookup Key "Lowercase"
IDataTypeIdentifier none
IDataTypeFormatter LowercaseStringFormatter
IDataTypeConverter none
IDataTypeComparer default

Group

Formatter

Remarks

String is converted to Lowercase.

Integer

Integer: "Integer"
Label Value
Native value typeof value === 'string'
Lookup Key "Integer"
IDataTypeIdentifier none
IDataTypeFormatter IntegerFormatter, uses Intl API
IDataTypeConverter IntegerConverter, uses Math.trunc()
IDataTypeComparer default

Group

Formatter

Remarks

When number is a whole number

Currency

Currency: "Currency"
Label Value
Native value typeof value === 'number'
Lookup Key "Currency"
IDataTypeIdentifier none
IDataTypeFormatter CurrencyFormatter, uses Intl API
IDataTypeConverter none
IDataTypeComparer default

Group

Formatter

Remarks

CurrencyFormatter needs your configuration to know the app's supported cultures and associated currency codes (like USD, EUR).

Percentage

Percentage: "Percentage"
Label Value
Native value typeof value === 'number'
Lookup Key "Percentage"
IDataTypeIdentifier none
IDataTypeFormatter PercentageFormatter, uses Intl API
IDataTypeConverter none
IDataTypeComparer default

Group

Formatter

Remarks

When number is a percentage, where 1.0 = 100%.

Percentage100

Percentage100: "Percentage100"
Label Value
Native value typeof value === 'number'
Lookup Key "Percentage100"
IDataTypeIdentifier none
IDataTypeFormatter Percentage100Formatter, uses Intl API
IDataTypeConverter none
IDataTypeComparer default

Group

Formatter

Remarks

When number is a percentage, where 100 = 100%.

ShortDate

ShortDate: "ShortDate"
Label Value
Native value value instanceof Date
Lookup Key "ShortDate"
IDataTypeIdentifier n/a
IDataTypeFormatter DateFormatter, uses Intl API
IDataTypeConverter n/a
IDataTypeComparer n/a

Group

Formatter

Remarks

Localized short date pattern, 1 or 2 digit month and day, 4 digit year.

AbbrevDate

AbbrevDate: "AbbrevDate"
Label Value
Native value value instanceof Date
Lookup Key "AbbrevDate"
IDataTypeIdentifier n/a
IDataTypeFormatter AbbrevDateFormatter, uses Intl API
IDataTypeConverter n/a
IDataTypeComparer n/a

Group

Formatter

Remarks

Localized abbreviated date pattern, month name to 3 letters.

LongDate

LongDate: "LongDate"
Label Value
Native value value instanceof Date
Lookup Key "LongDate"
IDataTypeIdentifier n/a
IDataTypeFormatter LongDateFormatter, uses Intl API
IDataTypeConverter n/a
IDataTypeComparer n/a

Group

Formatter

Remarks

Localized long date pattern, with complete month names.

AbbrevDOWDate

AbbrevDOWDate: "AbbrevDOWDate"
Label Value
Native value value instanceof Date
Lookup Key "AbbrevDOWDate"
IDataTypeIdentifier n/a
IDataTypeFormatter AbbrevDOWDateFormatter, uses Intl API
IDataTypeConverter n/a
IDataTypeComparer n/a

Group

Formatter

Remarks

Localized abbreviated date pattern and the day of week, month and DOW name to 3 letters.

LongDOWDate

LongDOWDate: "LongDOWDate"
Label Value
Native value value instanceof Date
Lookup Key "LongDOWDate"
IDataTypeIdentifier n/a
IDataTypeFormatter LongDOWDateFormatter, uses Intl API
IDataTypeConverter n/a
IDataTypeComparer n/a

Group

Formatter

Remarks

Localized Strings in an long date pattern and the day of week, complete month and DOW names.

TimeOfDay

TimeOfDay: "TimeOfDay"
Label Value
Native value value instanceof Date
Lookup Key "TimeOfDay"
IDataTypeIdentifier n/a
IDataTypeFormatter TimeOfDayFormatter, uses Intl API
IDataTypeConverter TimeOfDayOnlyConverter, as total minutes
IDataTypeComparer n/a

Group

Formatter

Remarks

Localized time of day part of date without seconds

TimeOfDayHMS

TimeOfDayHMS: "TimeOfDayHMS"
Label Value
Native value value instanceof Date
Lookup Key "TimeOfDayHMS"
IDataTypeIdentifier n/a
IDataTypeFormatter TimeOfDayHMSFormatter, uses
IDataTypeConverter TimeOfDayHMSOnlyConverter, as total seconds
IDataTypeComparer n/a

Group

Formatter

Remarks

Localized time of day part of date with seconds

YesNoBoolean

YesNoBoolean: "YesNoBoolean"
Label Value
Native value typeof value === 'boolean'
Lookup Key "YesNoBoolean"
IDataTypeIdentifier n/a
IDataTypeFormatter YesNoBooleanFormatter
IDataTypeConverter n/a
IDataTypeComparer n/a

Group

Formatter

Remarks

Converts boolean into "yes" and "no". This LookupKey is a model for the user to create more language specific boolean values. If used, YesNoBooleanFormatter needs your configuration to know the supported cultures associated values for "yes" and "no"

TotalDays

TotalDays: "TotalDays"
Label Value
Native value value instanceof Date
Lookup Key "TotalDays"
IDataTypeIdentifier none
IDataTypeFormatter n/a
IDataTypeConverter TotalDaysConverter
IDataTypeComparer default

Group

Converter

Remarks

For converting the Date into a number of days since Jan 1 1970. Helps with comparing the difference between two dates.

Milliseconds

Milliseconds: "Milliseconds"
Label Value
Native value value instanceof Date
Lookup Key "Milliseconds"
IDataTypeIdentifier none
IDataTypeFormatter n/a
IDataTypeConverter DateTimeConverter
IDataTypeComparer default

Group

Converter

Remarks

For converting the Date into a number of milliseconds since Jan 1 1970 (basically calling getTime() on the Date object) Helps with comparing the difference between two dates.

Seconds

Seconds: "Seconds"
Label Value
Native value value instanceof Date
Lookup Key "Seconds"
IDataTypeIdentifier none
IDataTypeFormatter n/a
IDataTypeConverter TimeOfDayHMSOnlyDateTimeConverter
IDataTypeComparer default

Group

Converter

Remarks

For converting the Date into a number of seconds since Jan 1 1970 Helps with comparing the difference between two dates.

Minutes

Minutes: "Minutes"
Label Value
Native value value instanceof Date
Lookup Key "Minutes"
IDataTypeIdentifier none
IDataTypeFormatter n/a
IDataTypeConverter TimeOfDayOnlyConverter
IDataTypeComparer default

Group

Converter

Remarks

For converting the Date into a number of minutes since Jan 1 1970 Helps with comparing the difference between two dates.

CaseInsensitive

CaseInsensitive: "CaseInsensitive"
Label Value
Native value typeof value === 'string'
Lookup Key "CaseInsensitive"
IDataTypeIdentifier n/a
IDataTypeFormatter n/a
IDataTypeConverter CaseInsensitiveConverter
IDataTypeComparer default

Group

Converter

Remarks

For case insensitive string comparisons. Generally set this on the ConditionConfig's ConversionLookupKey and SecondConversionLookupKey properties.

Settings

Member Visibility

Theme

On This Page

StringNumberBooleanDateDateTimeLocalDateCapitalizeUppercaseLowercaseIntegerCurrencyPercentagePercentage100ShortDateAbbrevDateLongDateAbbrevDOWDateLongDOWDateTimeOfDayTimeOfDayHMSYesNoBooleanTotalDaysMillisecondsSecondsMinutesCaseInsensitive

Generated using TypeDoc v0.25.12