Documentation

Utils

Type module

Sources

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

/**
 * --------------------------------------------------------
 * Import via main package: core.ts
 * Access items like: am5.utils.myVariable
 *                    am5.utils.myFunction()
 * --------------------------------------------------------
 */
import * as am5 from "@amcharts/amcharts5";

/**
 * --------------------------------------------------------
 * Import via: Utils.ts
 * Access items like: $utils.myVariable
 *                    $utils.myFunction()
 * --------------------------------------------------------
 */
import * as $utils from "@amcharts/amcharts5/Utils";


/**
 * --------------------------------------------------------
 * Include via "index.js"
 * E.g.: "https://cdn.amcharts.com/lib/5/index.js"
 * Access items like: am5.utils.myVariable
 *                    am5.utils.myFunction()
 * --------------------------------------------------------
 */

Variables

Utils does not have any variables.

Functions

addSpacing(

str: string

)

#

Returns string

Adds space before each uppercase letter.

alternativeColor(

color: iRGB,
lightAlternative: iRGB,
darkAlternative: iRGB

)

#

Returns iRGB

capitalizeFirst(

text: string

)

#

Returns string

contains(

a: Element,
b: Element

)

#

Returns boolean

Checks of element a contains element b.

escapeForRgex(

value: string

)

#

Returns string

Escapes string so it can safely be used in a Regex.

get12Hours(

hours: number,
base?: undefined | number

)

#

Returns number

Returns 12-hour representation out of the 24-hour hours.

getDayFromWeek(

week: number,
year: number,
weekday: number,
utc: boolean

)

#

Returns number

Returns a year day out of the given week number.

getEventTarget(

event: Event | Touch

)

#

Returns void

Gets the target of the event, works for shadow DOM too.

getMonthWeek(

date: Date,
utc: boolean

)

#

Returns number

Returns a week number in the month.

getSafeResolution()

#

Returns void

getShadowRoot(

a: Node

)

#

Returns ShadowRoot | null

Returns the shadow root of the element or null

getStyle(

dom: HTMLElement,
property: string

)

#

Returns void

getTimeZone(

date: Date,
long: boolean,
savings: boolean,
utc: boolean,
timezone?: undefined | string

)

#

Returns string

Returns a string name of the time zone.

getTimezoneOffset(

timezone: string

)

#

Returns number

getWeek(

date: Date,
_utc: boolean

)

#

Returns number

Returns week number for a given date.

@todo Account for UTC

getWeekYear(

date: Date,
_utc: boolean

)

#

Returns number

Returns a "week year" of the given date.

@since 5.3.0
@todo Account for UTC

getYearDay(

date: Date,
utc: boolean

)

#

Returns number

Returns a year day.

@todo Account for UTC

iOS()

#

Returns boolean

isLocalEvent(

event: IPointerEvent,
target: Sprite

)

#

Returns boolean

Returns true if pointer event originated on an element within Root.

@since 5.2.8

isTouchEvent(

ev: MouseEvent | Touch

)

#

Returns boolean

Determines if pointer event originated from a touch pointer or mouse.

onZoom(

listener: () => void

)

#

Returns IDisposer

Function that adds an event listener which is triggered when the browser's zoom changes.

padString(

value: any,
len: number,
char: string

)

#

Returns string

Pads a string with additional characters to certain length.

plainText(

text: string

)

#

Returns string

Removes new lines and tags from a string.

ready(

f: () => void

)

#

Returns void

Execute a function when DOM is ready.

@since 5.0.2

relativeToValue(

percent: number | Percent | undefined | null,
full: number

)

#

Returns number

removeElement(

el: HTMLElement

)

#

Returns void

Removes a DOM element.

setInteractive(

target: HTMLElement,
interactive: boolean

)

#

Returns void

Disables or enables interactivity of a DOM element.

stripTags(

text: string

)

#

Returns string

Strips all tags from the string.

trim(

text: string

)

#

Returns string

trimLeft(

text: string

)

#

Returns string

trimRight(

text: string

)

#

Returns string