Type

Type module

Sources

Items from Type can be imported/included and used via following ways.

TypeScript

/**
 * Import via main package
 * Access items like: am4core.type.myVariable
 */
import * as am4core from "@amcharts/amcharts4";

/**
 * Import via: Type.ts
 * Access items like: $type.myVariable
 */
import * as $type from "@amcharts/amcharts4/Type";

JavaScript

/**
 * Include via "core.js"
 * Access items like: am4core.type.myVariable
 */

Variables

Type does not have any variables.

Functions

#castNumber(value: string | number | Date)

Returns number

Casts string or a number into a number.

#castString(value: string | number)

Returns string

Deprecated Not used anywhere

Casts string or a number into string.

#checkArray(value: Array <A>)

Returns value

Deprecated Not used anywhere

Checks if the passed in value is an array.

#checkBoolean(value: any)

Returns value

Deprecated Not used anywhere

Checks if the passed in value is a boolean.

#checkDate(value: Date)

Returns value

Deprecated Not used anywhere

Checks if the passed in value is a Date object.

#checkNumber(value: any)

Returns value

Checks if the passed in value is a number.

#checkObject(value: object)

Returns value

Deprecated Not used anywhere

Checks if the passed in value is an object.

#checkString(value: any)

Returns value

Deprecated Not used anywhere

Checks if the passed in value is a string.

#getDefault(value: null | undefined | A,
optional: A)

Returns A

Deprecated Not used anywhere

Returns a default value if the passed in value is empty.

#getType(value: A)

Returns Type

Returns a type of the value.

#getValue(a: Optional <A> | null)

Returns A

Returns a value or throws an {Error} exception if the variable has not value.

#getValueDefault(a: Optional <A> | null,
defaultValue: A)

Returns A

Returns a value, or returns the default value if it doesn't have a value.

#hasValue(a: Optional <A> | null)

Returns a

Checks if a variable has a value.

#isArray(value: any)

Returns value

Checks if parameter is Array.

#isDate(value: any)

Returns value

Checks if parameter is Date.

#isNaN(value: number)

Returns boolean

Deprecated Is not used anywhere. JS built-in isNaN is used everywhere. Maybe we don't need this, or if we do, then we should use it everywhere

Returns true if value is not a number (NaN).

#isNumber(value: any)

Returns value

Checks if parameter is number.

#isObject(value: any)

Returns value

Checks if parameter is object.

#isString(value: any)

Returns value

Checks if parameter is string.

#toBoolean(value: any)

Returns boolean

Converts any value into boolean.

#toNumber(value: any)

Returns number

Converts any value into a number.

#toNumberOrPercent(value: any)

Returns number | Percent

Converts any value to a number or Percent.

If the parameter is a string and contains "%", it will convert it into a Percent.

Otherwise, it will convert into a number.

#toText(value: any)

Returns string

Converts any value into a string (text).