Funcs Class

Namespace: Stimulsoft.Data.Functions

Methods

Method Details

abs static

abs(value: number): void

Parameters

• value (number)

absObject static

absObject(value: any): any

Parameters

• value (any)

Returns any

acos static

acos(value: number): number

Parameters

• value (number)

Returns number

acosObject static

acosObject(value: any): any

Parameters

• value (any)

Returns any

addMonthsObject static

addMonthsObject(date: any, months: number): any

Parameters

• date (any)
• months (number)

Returns any

addYears static

addYears(date: DateTime, years: number): DateTime

Parameters

• date (DateTime)
• years (number)

Returns DateTime

addYearsObject static

addYearsObject(date: any, years: number): any

Parameters

• date (any)
• years (number)

Returns any

all static

all(value: any): any

Parameters

• value (any)

Returns any

asin static

asin(value: number): number

Parameters

• value (number)

Returns number

asinObject static

asinObject(value: any): any

Parameters

• value (any)

Returns any

atan static

atan(value: number): any

Parameters

• value (number)

Returns any

atanObject static

atanObject(value: any): any

Parameters

• value (any)

Returns any

avg static

avg(value: any): number

Parameters

• value (any)

Returns number

avgDate static

avgDate(value: any): DateTime | null

Parameters

• value (any)

Returns DateTime | null

avgNulls static

avgNulls(value: any): number

Parameters

• value (any)

Returns number

avgTime static

avgTime(value: any): TimeSpan | null

Parameters

• value (any)

Returns TimeSpan | null

calculate static

calculate(functionn: string, values: object[]): any

Parameters

• functionn (string)
• values (object[])

Returns any

ceiling static

ceiling(value: number): number

Parameters

• value (number)

Returns number

ceilingObject static

ceilingObject(value: any): any

Parameters

• value (any)

Returns any

cos static

cos(value: number): number

Parameters

• value (number)

Returns number

cosObject static

cosObject(value: any): any

Parameters

• value (any)

Returns any

count static

count(value: any): number

Parameters

• value (any)

Returns number

countIf static

countIf(value: any, condition: any): number

Parameters

• value (any)
• condition (any)

Returns number

dateDiff static

dateDiff(date1: DateTime | null, date2: DateTime | null): TimeSpan | null

Parameters

• date1 (DateTime | null)
• date2 (DateTime | null)

Returns TimeSpan | null

dateDiffObject static

dateDiffObject(value1: any, value2: any): any

Parameters

• value1 (any)
• value2 (any)

Returns any

dateTime static

dateTime(value: any): any

Parameters

• value (any)

Returns any

day static

day(dateTime: DateTime | null): number

Parameters

• dateTime (DateTime | null)

Returns number

dayObject static

dayObject(value: any): any

Parameters

• value (any)

Returns any

dayOfWeek static

dayOfWeek(date: DateTime | null): string

Parameters

• date (DateTime | null)

Returns string

dayOfWeek2 static

dayOfWeek2(date: DateTime | null, localized: boolean): string

Parameters

• date (DateTime | null)
• localized (boolean)

Returns string

dayOfWeek3 static

dayOfWeek3(date: DateTime | null, culture: string): string

Parameters

• date (DateTime | null)
• culture (string)

Returns string

dayOfWeek4 static

dayOfWeek4(date: DateTime | null, culture: string, upperCase: boolean): string

Parameters

• date (DateTime | null)
• culture (string)
• upperCase (boolean)

Returns string

dayOfWeekIdent static

dayOfWeekIdent(dateTime: DateTime | null): DayOfWeek | null

Parameters

• dateTime (DateTime | null)

Returns DayOfWeek | null

dayOfWeekIdentObject static

dayOfWeekIdentObject(value: any): any

Parameters

• value (any)

Returns any

dayOfWeekIndex static

dayOfWeekIndex(dateTime: DateTime | null): number

Parameters

• dateTime (DateTime | null)

Returns number

dayOfWeekIndexObject static

dayOfWeekIndexObject(value: any): any

Parameters

• value (any)

Returns any

dayOfWeekObject static

dayOfWeekObject(value: any): any

Parameters

• value (any)

Returns any

dayOfWeekObject2 static

dayOfWeekObject2(value: any, localized: boolean): any

Parameters

• value (any)
• localized (boolean)

Returns any

dayOfWeekObject3 static

dayOfWeekObject3(value: any, culture: string): any

Parameters

• value (any)
• culture (string)

Returns any

dayOfWeekObject4 static

dayOfWeekObject4(value: any, culture: string, upperCase: boolean): any

Parameters

• value (any)
• culture (string)
• upperCase (boolean)

Returns any

dayOfYear static

dayOfYear(dateTime: DateTime | null): number

Parameters

• dateTime (DateTime | null)

Returns number

dayOfYearObject static

dayOfYearObject(value: any): any

Parameters

• value (any)

Returns any

daysInMonth static

daysInMonth(year: number, month: number): number

Parameters

• year (number)
• month (number)

Returns number

daysInMonth2 static

daysInMonth2(date: DateTime | null): number

Parameters

• date (DateTime | null)

Returns number

daysInMonthObject static

daysInMonthObject(value1: any, value2: any): any

Parameters

• value1 (any)
• value2 (any)

Returns any

daysInMonthObject2 static

daysInMonthObject2(value: any): any

Parameters

• value (any)

Returns any

daysInYear static

daysInYear(year: number): number

Parameters

• year (number)

Returns number

daysInYear2 static

daysInYear2(date: DateTime | null): number

Parameters

• date (DateTime | null)

Returns number

daysInYearObject static

daysInYearObject(value: any): any

Parameters

• value (any)

Returns any

distinct static

distinct(value: any): any

Parameters

• value (any)

Returns any

distinctCount static

distinctCount(value: any): number

Parameters

• value (any)

Returns number

distinctCountIf static

distinctCountIf(value: any, condition: any): number

Parameters

• value (any)
• condition (any)

Returns number

div static

div(value1: number, value2: number, zeroResult: number | null): number | null

Parameters

• value1 (number)
• value2 (number)
• zeroResult (number | null)

Returns number | null

divObject static

divObject(value1: any, value2: any, zeroResult: any): number

Parameters

• value1 (any)
• value2 (any)
• zeroResult (any)

Returns number

existsCustomFunction static

existsCustomFunction(funcName: string): boolean

Parameters

• funcName (string)

Returns boolean

exp static

exp(value: number): number

Parameters

• value (number)

Returns number

expObject static

expObject(value: any): any

Parameters

• value (any)

Returns any

financialQuarter static

financialQuarter(dateTime: DateTime | null): StiQuarter | null

Parameters

• dateTime (DateTime | null)

Returns StiQuarter | null

financialQuarterIndex static

financialQuarterIndex(dateTime: DateTime | null): number

Parameters

• dateTime (DateTime | null)

Returns number

financialQuarterIndexObject static

financialQuarterIndexObject(value: any): any

Parameters

• value (any)

Returns any

financialQuarterObject static

financialQuarterObject(value: any): any

Parameters

• value (any)

Returns any

first static

first(value: any): any

Parameters

• value (any)

Returns any

fiscalMonthIdent static

fiscalMonthIdent(dateTime: DateTime, startMonth: any): StiFiscalMonth

Parameters

• dateTime (DateTime)
• startMonth (any)

Returns StiFiscalMonth

fiscalMonthIdentObject static

fiscalMonthIdentObject(value: any, startMonth: any): any

Parameters

• value (any)
• startMonth (any)

Returns any

floor static

floor(value: number): number

Parameters

• value (number)

Returns number

floorObject static

floorObject(value: any): any

Parameters

• value (any)

Returns any

format static

format(format: string, value: any): string

Parameters

• format (string)
• value (any)

Returns string

formatObject static

formatObject(format: string, value: any): any

Parameters

• format (string)
• value (any)

Returns any

getAggregateMeasureFunctions static

getAggregateMeasureFunctions(): string[]

Returns string[]

getCommonMeasureFunctions static

getCommonMeasureFunctions(): string[]

Returns string[]

getCustomFunction static

getCustomFunction(funcName: string, argumentTypes: Type[]): IStiAppFunction

Parameters

• funcName (string)
• argumentTypes (Type[])

Returns IStiAppFunction

getCustomFunctions static

getCustomFunctions(funcName: string): IStiAppFunction[]

Parameters

• funcName (string)

Returns IStiAppFunction[]

getDateDimensionFunctions static

getDateDimensionFunctions(): string[]

Returns string[]

getIso2ConvertedValues static

getIso2ConvertedValues(name: string): string[]

Parameters

• name (string)

Returns string[]

getMapIdents static

getMapIdents(key: string): string[]

Parameters

• key (string)

Returns string[]

getMeasureFunctions static

getMeasureFunctions(): string[]

Returns string[]

getSystemVariable static

getSystemVariable(variable: StiSystemVariableObject, line: number): any

Parameters

• variable (StiSystemVariableObject)
• line (number)

Returns any

hour static

hour(dateTime: DateTime | null): number

Parameters

• dateTime (DateTime | null)

Returns number

hourObject static

hourObject(value: any): any

Parameters

• value (any)

Returns any

image static

image(value: any, width: any, height: any): any

Parameters

• value (any)
• width (any)
• height (any)

Returns any

insert static

insert(str: string, startIndex: number, subStr: string): string

Parameters

• str (string)
• startIndex (number)
• subStr (string)

Returns string

insertObject static

insertObject(value: any, startIndex: number, subStr: string): any

Parameters

• value (any)
• startIndex (number)
• subStr (string)

Returns any

invokeCustomFunction static

invokeCustomFunction(funcName: string, argumentss: any[]): any

Parameters

• funcName (string)
• argumentss (any[])

Returns any

isAggregationFunction static

isAggregationFunction(functionn: string): boolean

Parameters

• functionn (string)

Returns boolean

isDataEqual static

isDataEqual(dataSource: IStiAppDataSource, dataColumnName: string, searchColumnName: string): boolean

Parameters

• dataSource (IStiAppDataSource)
• dataColumnName (string)
• searchColumnName (string)

Returns boolean

isMeasureFunction static

isMeasureFunction(expression: string): boolean

Parameters

• expression (string)

Returns boolean

isValidUrl static

isValidUrl(hyperlink: string): boolean

Parameters

• hyperlink (string)

Returns boolean

iso2 static

iso2(name: string, mapId: string, lang: string): string

Parameters

• name (string)
• mapId (string)
• lang (string)

Returns string

iso2Object static

iso2Object(value: any, mapId: string, lang: string): any

Parameters

• value (any)
• mapId (string)
• lang (string)

Returns any

iso2ToName static

iso2ToName(alpha2: string, mapId: string, lang: string): string

Parameters

• alpha2 (string)
• mapId (string)
• lang (string)

Returns string

iso2ToNameObject static

iso2ToNameObject(value: any, mapId: string, lang: string): any

Parameters

• value (any)
• mapId (string)
• lang (string)

Returns any

iso3 static

iso3(name: string, mapId: string, lang: string): string

Parameters

• name (string)
• mapId (string)
• lang (string)

Returns string

iso3Object static

iso3Object(value: any, mapId: string, lang: string): any

Parameters

• value (any)
• mapId (string)
• lang (string)

Returns any

iso3ToName static

iso3ToName(alpha3: string, mapId: string, lang: string): string

Parameters

• alpha3 (string)
• mapId (string)
• lang (string)

Returns string

iso3ToNameObject static

iso3ToNameObject(value: any, mapId: string, lang: string): any

Parameters

• value (any)
• mapId (string)
• lang (string)

Returns any

last static

last(value: any): any

Parameters

• value (any)

Returns any

left static

left(str: string, length: any): string

Parameters

• str (string)
• length (any)

Returns string

leftObject static

leftObject(value: any, length: any): any

Parameters

• value (any)
• length (any)

Returns any

length2 static

length2(str: string): number

Parameters

• str (string)

Returns number

lengthObject static

lengthObject(value: any): any

Parameters

• value (any)

Returns any

localize static

localize(func: string): string

Parameters

• func (string)

Returns string

log static

log(value: number): number

Parameters

• value (number)

Returns number

logObject static

logObject(value: any): any

Parameters

• value (any)

Returns any

makeDate static

makeDate(year: number, month: any, day: any): DateTime

Parameters

• year (number)
• month (any)
• day (any)

Returns DateTime

makeDateObject static

makeDateObject(year: any, month: any, day: any): any

Parameters

• year (any)
• month (any)
• day (any)

Returns any

makeDateTime static

makeDateTime(year: number, month: any, day: any, hour: any, minute: any, second: any): DateTime

Parameters

• year (number)
• month (any)
• day (any)
• hour (any)
• minute (any)
• second (any)

Returns DateTime

makeDateTimeObject static

makeDateTimeObject(year: any, month: any, day: any, hour: any, minute: any, second: any): any

Parameters

• year (any)
• month (any)
• day (any)
• hour (any)
• minute (any)
• second (any)

Returns any

makeTime static

makeTime(hour: number, minute: any, second: any): DateTime

Parameters

• hour (number)
• minute (any)
• second (any)

Returns DateTime

makeTimeObject static

makeTimeObject(hour: any, minute: any, second: any): any

Parameters

• hour (any)
• minute (any)
• second (any)

Returns any

max static

max(value: any): number

Parameters

• value (any)

Returns number

maxD static

maxD(value: any): number

Parameters

• value (any)

Returns number

maxDate static

maxDate(value: any): DateTime | null

Parameters

• value (any)

Returns DateTime | null

maxI static

maxI(value: any): number

Parameters

• value (any)

Returns number

maxNulls static

maxNulls(value: number): number

Parameters

• value (number)

Returns number

maxStr static

maxStr(value: any): string

Parameters

• value (any)

Returns string

maxTime static

maxTime(value: any): TimeSpan | null

Parameters

• value (any)

Returns TimeSpan | null

median static

median(value: any): number

Parameters

• value (any)

Returns number

min static

min(value: any): number

Parameters

• value (any)

Returns number

minDate static

minDate(value: any): DateTime | null

Parameters

• value (any)

Returns DateTime | null

minMaxDateString static

minMaxDateString(value: any): string

Parameters

• value (any)

Returns string

minNulls static

minNulls(value: any): number

Parameters

• value (any)

Returns number

minStr static

minStr(value: any): string

Parameters

• value (any)

Returns string

minTime static

minTime(value: any): TimeSpan | null

Parameters

• value (any)

Returns TimeSpan | null

minute static

minute(dateTime: DateTime | null): number

Parameters

• dateTime (DateTime | null)

Returns number

minuteObject static

minuteObject(value: any): any

Parameters

• value (any)

Returns any

mode static

mode(value: any): number

Parameters

• value (any)

Returns number

month static

month(dateTime: DateTime | null): number

Parameters

• dateTime (DateTime | null)

Returns number

monthIdent static

monthIdent(dateTime: DateTime | null): StiMonth | null

Parameters

• dateTime (DateTime | null)

Returns StiMonth | null

monthIdentObject static

monthIdentObject(value: any): any

Parameters

• value (any)

Returns any

monthName static

monthName(date: DateTime | null): string

Parameters

• date (DateTime | null)

Returns string

monthName2 static

monthName2(date: DateTime | null, localized: boolean): string

Parameters

• date (DateTime | null)
• localized (boolean)

Returns string

monthName3 static

monthName3(date: DateTime | null, culture: string): string

Parameters

• date (DateTime | null)
• culture (string)

Returns string

monthName4 static

monthName4(date: DateTime | null, culture: string, upperCase: boolean): string

Parameters

• date (DateTime | null)
• culture (string)
• upperCase (boolean)

Returns string

monthNameObject static

monthNameObject(value: any): any

Parameters

• value (any)

Returns any

monthNameObject2 static

monthNameObject2(value: any, localized: boolean): any

Parameters

• value (any)
• localized (boolean)

Returns any

monthNameObject3 static

monthNameObject3(value: any, culture: string): any

Parameters

• value (any)
• culture (string)

Returns any

monthNameObject4 static

monthNameObject4(value: any, culture: string, upperCase: boolean): any

Parameters

• value (any)
• culture (string)
• upperCase (boolean)

Returns any

monthObject static

monthObject(value: any): any

Parameters

• value (any)

Returns any

normalizeName static

normalizeName(alpha3: string, mapId: string, lang: string): string

Parameters

• alpha3 (string)
• mapId (string)
• lang (string)

Returns string

normalizeNameObject static

normalizeNameObject(value: any, mapId: string, lang: string): any

Parameters

• value (any)
• mapId (string)
• lang (string)

Returns any

now static

now(): DateTime

Returns DateTime

optionalSkipNulls static

optionalSkipNulls(values: List

Parameters

• values (List

Returns List

quarter static

quarter(dateTime: DateTime | null): StiQuarter | null

Parameters

• dateTime (DateTime | null)

Returns StiQuarter | null

quarterIndex static

quarterIndex(dateTime: DateTime | null): number

Parameters

• dateTime (DateTime | null)

Returns number

quarterIndexObject static

quarterIndexObject(value: any): any

Parameters

• value (any)

Returns any

quarterName static

quarterName(dateTime: DateTime | null, localized: any): string

Parameters

• dateTime (DateTime | null)
• localized (any)

Returns string

quarterNameObject static

quarterNameObject(value: any, localized: any): any

Parameters

• value (any)
• localized (any)

Returns any

quarterObject static

quarterObject(value: any): any

Parameters

• value (any)

Returns any

remove static

remove(str: string, startIndex: number, count: number): string

Parameters

• str (string)
• startIndex (number)
• count (number)

Returns string

removeObject static

removeObject(value: any, startIndex: number, count: number): any

Parameters

• value (any)
• startIndex (number)
• count (number)

Returns any

replace static

replace(str: string, oldValue: string, newValue: string): string

Parameters

• str (string)
• oldValue (string)
• newValue (string)

Returns string

replaceObject static

replaceObject(value: any, oldValue: string, newValue: string): any

Parameters

• value (any)
• oldValue (string)
• newValue (string)

Returns any

right static

right(str: string, length: any): string

Parameters

• str (string)
• length (any)

Returns string

rightObject static

rightObject(value: any, length: any): any

Parameters

• value (any)
• length (any)

Returns any

round static

round(value: number, decimals: any): number

Parameters

• value (number)
• decimals (any)

Returns number

roundObject static

roundObject(value: any, decimals: any): any

Parameters

• value (any)
• decimals (any)

Returns any

second static

second(dateTime: DateTime | null): number

Parameters

• dateTime (DateTime | null)

Returns number

secondObject static

secondObject(value: any): any

Parameters

• value (any)

Returns any

sign static

sign(value: number): number

Parameters

• value (number)

Returns number

signObject static

signObject(value: any): any

Parameters

• value (any)

Returns any

sin static

sin(value: number): number

Parameters

• value (number)

Returns number

sinObject static

sinObject(value: any): any

Parameters

• value (any)

Returns any

skipNulls static

skipNulls(values: List): [List](/Stimulsoft.Reports.Class.Reference.JS/Stimulsoft_System_Collections_Generic/List.html)

Parameters

• values (List)

Returns List

sqrt static

sqrt(value: number): number

Parameters

• value (number)

Returns number

sqrtObject static

sqrtObject(value: any): any

Parameters

• value (any)

Returns any

stDev static

stDev(value: any): number

Parameters

• value (any)

Returns number

stDevP static

stDevP(value: any): number

Parameters

• value (any)

Returns number

substring static

substring(str: string, startIndex: number, length: any): string

Parameters

• str (string)
• startIndex (number)
• length (any)

Returns string

substringObject static

substringObject(value: any, startIndex: number, length: any): any

Parameters

• value (any)
• startIndex (number)
• length (any)

Returns any

sum static

sum(value: any): number

Parameters

• value (any)

Returns number

sumD static

sumD(value: any): number

Parameters

• value (any)

Returns number

sumDIf static

sumDIf(value: any, condition: any): number

Parameters

• value (any)
• condition (any)

Returns number

sumDistinct static

sumDistinct(value: any): number

Parameters

• value (any)

Returns number

sumDistinctIf static

sumDistinctIf(value: any, condition: any): number

Parameters

• value (any)
• condition (any)

Returns number

sumI static

sumI(value: any): number

Parameters

• value (any)

Returns number

sumIIf static

sumIIf(value: any, condition: any): number

Parameters

• value (any)
• condition (any)

Returns number

sumIf static

sumIf(value: any, condition: any): number

Parameters

• value (any)
• condition (any)

Returns number

sumNulls static

sumNulls(value: any): number

Parameters

• value (any)

Returns number

sumTime static

sumTime(value: any): TimeSpan

Parameters

• value (any)

Returns TimeSpan

sumTimeIf static

sumTimeIf(value: any, condition: any): TimeSpan

Parameters

• value (any)
• condition (any)

Returns TimeSpan

tan static

tan(value: number): number

Parameters

• value (number)

Returns number

tanObject static

tanObject(value: any): any

Parameters

• value (any)

Returns any

time static

time(value: any): any

Parameters

• value (any)

Returns any

toABC static

toABC(value: number): string

Converts the number to A B C D representation for numbering of the list.

Parameters

• value (number) — A number for converting into the A B C representation.

Returns string — String representation of the value in A B C D format.

toABCNumeric static

toABCNumeric(value: number): string

Converts the number to A B C D representation for numbering of the list.

Parameters

• value (number) — A number for converting into the A B C representation.

Returns string — String representation of the value in A B C D format.

toABCRu static

toABCRu(value: number): string

Converts the number to ¿ ¡ ¬ representation for numbering of the list in russian.

Parameters

• value (number) — A number for converting into the ¿ ¡ ¬ representation.

Returns string — String representation of the value in ¿ ¡ ¬ format.

toArabic static

toArabic(value: string | number, useEasternDigits: boolean): string

Converts all digits in the string to the arabic representation.

Parameters

• value (string | number) — A string or number for converting into the arabic representation.
• useEasternDigits (boolean) — Use eastern or standard arabic digits.

Returns string — String with arabic digits.

toDataName static

toDataName(name: string): string

Parameters

• name (string)

Returns string

toDataNameWithoutRelation static

toDataNameWithoutRelation(name: string, dataSources: IStiAppDataSource[]): string

Parameters

• name (string)
• dataSources (IStiAppDataSource[])

Returns string

toExpression static

toExpression(name: string): string

Parameters

• name (string)

Returns string

toExpression2 static

toExpression2(sourceName: string, columnName: string): string

Parameters

• sourceName (string)
• columnName (string)

Returns string

toLowerCase static

toLowerCase(str: string): string

Parameters

• str (string)

Returns string

toLowerCaseObject static

toLowerCaseObject(value: any): any

Parameters

• value (any)

Returns any

toProperCase static

toProperCase(str: string): string

Parameters

• str (string)

Returns string

toProperCaseObject static

toProperCaseObject(value: any): any

Parameters

• value (any)

Returns any

toRoman static

toRoman(value: number): string

Converts Arabic numerals to Roman.

Parameters

• value (number) — Arabic numerals for converting to the Roman format.

Returns string — Returns Arabics numerals in Roman.

toString static

toString(value: any): string

Parameters

• value (any)

Returns string

toStringObject static

toStringObject(value: any): any

Parameters

• value (any)

Returns any

toUpperCase static

toUpperCase(str: string): string

Parameters

• str (string)

Returns string

toUpperCaseObject static

toUpperCaseObject(value: any): any

Parameters

• value (any)

Returns any

trim static

trim(str: string): string

Parameters

• str (string)

Returns string

trimEnd static

trimEnd(str: string): string

Parameters

• str (string)

Returns string

trimEndObject static

trimEndObject(value: any): any

Parameters

• value (any)

Returns any

trimObject static

trimObject(value: any): any

Parameters

• value (any)

Returns any

trimStart static

trimStart(str: string): string

Parameters

• str (string)

Returns string

trimStartObject static

trimStartObject(value: any): any

Parameters

• value (any)

Returns any

truncate static

truncate(value: number): number

Parameters

• value (number)

Returns number

truncateObject static

truncateObject(value: any): any

Parameters

• value (any)

Returns any

year static

year(dateTime: DateTime | null): number

Parameters

• dateTime (DateTime | null)

Returns number

yearMonth static

yearMonth(dateTime: DateTime | null): string

Parameters

• dateTime (DateTime | null)

Returns string

yearMonthObject static

yearMonthObject(value: any): any

Parameters

• value (any)

Returns any

yearObject static

yearObject(value: any): any

Parameters

• value (any)

Returns any

Fields