wijmo Module

File
wijmo.js
Module
wijmo

Classes

Interfaces

Enums

Properties

Methods

Properties

culture

Gets or sets an object that contains all localizable strings in the Wijmo library.

The culture selector is a two-letter string that represents an ISO 639 culture.

Type
any

Methods

addClass

addClass(e: Element, className: string): void

Adds a class to an element.

Parameters
Returns
void

animate

animate(apply: IAnimateCallback, duration?: number, step?: number): any

Calls a function on a timer with a parameter varying between zero and one.

Use this function to create animations by modifying document properties or styles on a timer.

For example, the code below changes the opacity of an element from zero to one in one second:

```typescript import { animate } from '@grapecity/wijmo'; const element = document.getElementById('someElement'); animate(pct => { element.style.opacity = pct; }, 1000); ```

The function returns an interval ID that you can use to stop the animation. This is typically done when you are starting a new animation and wish to suspend other on-going animations on the same element. For example, the code below keeps track of the interval ID and clears if before starting a new animation:

```typescript import { animate } from '@grapecity/wijmo'; const element = document.getElementById('someElement'); if (this._animInterval) { clearInterval(this._animInterval); } this._animInterval = animate(pct => { element.style.opacity = pct; if (pct == 1) { self._animInterval = null; } }, 1000); ```

Parameters
Returns
any

asArray

asArray(value: any, nullOK?: boolean): any[]

Asserts that a value is an array.

Parameters
Returns
any[]

asBoolean

asBoolean(value: boolean, nullOK?: boolean): boolean

Asserts that a value is a Boolean.

Parameters
Returns
boolean

asCollectionView

asCollectionView(value: any, nullOK?: boolean): ICollectionView

Asserts that a value is an ICollectionView or an Array.

Parameters
Returns
ICollectionView

asDate

asDate(value: Date, nullOK?: boolean): Date

Asserts that a value is a Date.

Parameters
Returns
Date

asEnum

asEnum(value: number, enumType: any, nullOK?: boolean): number

Asserts that a value is a valid setting for an enumeration.

Parameters
Returns
number

asFunction

asFunction(value: any, nullOK?: boolean): Function

Asserts that a value is a function.

Parameters
Returns
Function

asInt

asInt(value: number, nullOK?: boolean, positive?: boolean): number

Asserts that a value is an integer.

Parameters
Returns
number

asNumber

asNumber(value: number, nullOK?: boolean, positive?: boolean): number

Asserts that a value is a number.

Parameters
Returns
number

assert

assert(condition: boolean, msg: string): void

Throws an exception if a condition is false.

Parameters
Returns
void

asString

asString(value: string, nullOK?: boolean): string

Asserts that a value is a string.

Parameters
Returns
string

asType

asType(value: any, type: any, nullOK?: boolean): any

Asserts that a value is an instance of a given type.

Parameters
Returns
any

changeType

changeType(value: any, type: DataType, format?: string, refDate?: Date): any

Changes the type of a value.

If the conversion fails, the original value is returned. To check if a conversion succeeded, you should check the type of the returned value.

Parameters
Returns
any

clamp

clamp(value: number, min: number, max: number): number

Clamps a value between a minimum and a maximum.

Parameters
Returns
number

closest

closest(e: any, selector: string): Element

Finds the closest ancestor (including the original element) that satisfies a selector.

Parameters
Returns
Element

closestClass

closestClass(e: any, className: string): Node

Finds the closest ancestor (including the original element) that satisfies a class selector.

Parameters
Returns
Node

contains

contains(parent: any, child: any, popup?: boolean): boolean

Checks whether an HTML element contains another.

Parameters
Returns
boolean

copy

copy(dst: any, src: any): any

Copies properties from an object to another.

This method is typically used to initialize controls and other Wijmo objects by setting their properties and assigning event handlers.

The destination object must define all the properties defined in the source, or an error will be thrown.

Parameters
Returns
any

createElement

createElement(html: string, appendTo?: HTMLElement, css?: any): HTMLElement

Creates an element from an HTML string.

Parameters
Returns
HTMLElement

disableAutoComplete

disableAutoComplete(e: HTMLInputElement): void

Disables the autocomplete, autocorrect, autocapitalize, and spellcheck properties of an input element.

Parameters
Returns
void

enable

enable(e: HTMLElement, value: boolean): void

Enables or disables an element.

Parameters
Returns
void

escapeHtml

escapeHtml(text: string): string

Escapes a string by replacing HTML characters with text entities.

Strings entered by users should always be escaped before they are displayed in HTML pages. This helps ensure page integrity and prevent HTML/javascript injection attacks.

Parameters
Returns
string

escapeRegExp

escapeRegExp(text: string): string

Escapes a string by prefixing special regular expression characters with backslashes.

Parameters
Returns
string

evalTemplate

evalTemplate(template: string, ctx?: any): string

Evaluates a string in template literal notation.

This function allows you to evaluate template literals on-demand, rather than when they are declared.

The template string uses the standard template literal syntax, except it is a regular string (enclosed in single or double quotes) rather than a template literal (enclosed in back-quotes).

The template string may contain references to variables provided in a context object passed as a parameter.

The template string may contain formatting information as used with the glbz tag function.

For example: ```typescript import { evalTemplate } from '@grapecity/wijmo'; const msg = evalTemplate('hello ${user}, want some ${Math.PI}:n2?', { user: 'Chris' })); console.log(msg); > hello Chris, want some 3.14? ```

Parameters
Returns
string

format

format(format: string, data: any, formatFunction?: Function): string

Replaces each format item in a specified string with the text equivalent of an object's value.

The function works by replacing parts of the formatString with the pattern '{name:format}' with properties of the data parameter. For example:

```typescript import { format } from '@grapecity/wijmo'; let data = { name: 'Joe', amount: 123456 }, msg = format('Hello {name}, you won {amount:n2}!', data); ```

The format function supports pluralization. If the format string is a JSON-encoded object with 'count' and 'when' properties, the method uses the 'count' parameter of the data object to select the appropriate format from the 'when' property. For example:

```typescript import { format } from '@grapecity/wijmo'; fmtObj fmt = { count: 'count', when: { 0: 'No items selected.', 1: 'One item is selected.', 2: 'A pair is selected.', 'other': '{count:n0} items are selected.' } }; let fmt = JSON.stringify(fmtObj); console.log(format(fmt, { count: 0 })); // No items selected. console.log(format(fmt, { count: 1 })); // One item is selected. console.log(format(fmt, { count: 2 })); // A pair is selected. console.log(format(fmt, { count: 12 })); // 12 items are selected. ```

The optional formatFunction allows you to customize the content by providing context-sensitive formatting. If provided, the format function gets called for each format element and gets passed the data object, the parameter name, the format, and the value; it should return an output string. For example:

```typescript import { format, isString, escapeHtml } from '@grapecity/wijmo'; let data = { name: 'Joe', amount: 123456 }, msg = format('Hello {name}, you won {amount:n2}!', data, (data, name, fmt, val) => { if (isString(data[name])) { val = escapeHtml(data[name]); } return val; } ); ```

Parameters
Returns
string

getActiveElement

getActiveElement(): HTMLElement

Gets a reference to the element that contains the focus, accounting for shadow document fragments.

Returns
HTMLElement

getAggregate

getAggregate(aggType: Aggregate, items: any[], binding?: string): void

Calculates an aggregate value from the values in an array.

Parameters
Returns
void

getElement

getElement(selector: any): HTMLElement

Gets an element from a query selector.

Parameters
Returns
HTMLElement

getElementRect

getElementRect(e: Element): Rect

Gets the bounding rectangle of an element in page coordinates.

This is similar to the getBoundingClientRect function, except that uses viewport coordinates, which change when the document scrolls.

Parameters
Returns
Rect

getType

getType(value: any): DataType

Gets the type of a value.

Parameters
Returns
DataType

getTypes

getTypes(arr: any[]): IBindingInfo[]

Gets an array containing the names and types of items in an array.

Parameters
Returns
IBindingInfo[]

getUniqueId

getUniqueId(baseId: string): string

Creates a new unique id for an element by adding sequential numbers to a given base id.

Parameters
Returns
string

getVersion

getVersion(): string

Gets the version of the Wijmo library that is currently loaded.

Returns
string

glbz

glbz(...args: any[]): string

Tag function for use with template literals.

The glbz tag function allows you to specify formatting for variables in template literal expressions.

To format a variable in a template literal using glbz, add a colon and the format string after the name of the variable you want to format.

For example:

```typescript import { glbz } from '@grapecity/wijmo'; let num = 42, dt = new Date(), msg = glbz`the number is ${num}:n2, and the date is ${dt}:'MMM d, yyyy'!`; ```

Parameters
Returns
string

hasClass

hasClass(e: Element, className: string): boolean

Checks whether an element has a class.

Parameters
Returns
boolean

hasItems

hasItems(value: ICollectionView): boolean

Checks whether an ICollectionView is defined and not empty.

Parameters
Returns
boolean

hidePopup

hidePopup(popup: HTMLElement, remove?: any, fadeOut?: boolean): any

Hides a popup element previously displayed with the showPopup method.

Parameters
Returns
any

httpRequest

httpRequest(url: string, options?: IHttpRequestOptions): XMLHttpRequest

Performs HTTP requests.

Use the success method to obtain the result of the request which is provided in the callback's XMLHttpRequest parameter. For example, the code below uses the httpRequest method to retrieve a list of customers from an OData service:

```typescript import { httpRequest } from '@grapecity/wijmo'; httpRequest('https://services.odata.org/Northwind/Northwind.svc/Customers?$format=json', { success: xhr => { let response = JSON.parse(xhr.responseText), customers = response.value; // do something with the customers... } }); ```

Parameters
Returns
XMLHttpRequest

isArray

isArray(value: any): value

Determines whether an object is an Array.

Parameters
Returns
value

isBoolean

isBoolean(value: any): value

Determines whether an object is a Boolean.

Parameters
Returns
value

isDate

isDate(value: any): value

Determines whether an object is a Date.

Parameters
Returns
value

isEmpty

isEmpty(obj: any): boolean

Determines whether an object is empty (contains no enumerable properties).

Parameters
Returns
boolean

isFunction

isFunction(value: any): value

Determines whether an object is a function.

Parameters
Returns
value

isInt

isInt(value: any): value

Determines whether an object is an integer.

Parameters
Returns
value

isNullOrWhiteSpace

isNullOrWhiteSpace(value: string): boolean

Determines whether a string is null, empty, or whitespace only.

Parameters
Returns
boolean

isNumber

isNumber(value: any): value

Determines whether an object is a number.

Parameters
Returns
value

isObject

isObject(value: any): boolean

Determines whether a value is an object (as opposed to a value type, an array, or a Date).

Parameters
Returns
boolean

isPrimitive

isPrimitive(value: any): value

Determines whether an object is a primitive type (string, number, Boolean, or Date).

Parameters
Returns
value

isString

isString(value: any): value

Determines whether an object is a string.

Parameters
Returns
value

isUndefined

isUndefined(value: any): value

Determines whether an object is undefined.

Parameters
Returns
value

mouseToPage

mouseToPage(e: any): Point

Converts mouse or touch event arguments into a Point in page coordinates.

Parameters
Returns
Point

moveFocus

moveFocus(parent: HTMLElement, offset: number): boolean

Moves the focus to the next/previous/first focusable child within a given parent element.

Parameters
Returns
boolean

removeChild

removeChild(e: Node): Node

Safely removes an element from the DOM tree.

Parameters
Returns
Node

removeClass

removeClass(e: Element, className: string): void

Removes a class from an element.

Parameters
Returns
void

saveFile

saveFile(content: string, fileName: string, type?: string): void

Saves content to a file.

Parameters
Returns
void

setAriaLabel

setAriaLabel(e: Element, value?: string): void

Sets or clears an element's aria-label attribute.

Parameters
Returns
void

setAttribute

setAttribute(e: Element, name: string, value?: any, keep?: boolean): void

Sets or clears an attribute on an element.

Parameters
Returns
void

setChecked

setChecked(cb: HTMLInputElement, checked: boolean): void

Sets the checked and indeterminate properties of a checkbox input element.

Parameters
Returns
void

setCss

setCss(e: any, css: any): void

Modifies the style of an element by applying the properties specified in an object.

Parameters
Returns
void

setLicenseKey

setLicenseKey(licenseKey: string): void

Sets the license key that identifies licensed Wijmo applications.

If you do not set the license key, Wijmo will run in evaluation mode, adding a watermark element to the page.

Licensed users may obtain keys at the My Account section of the Wijmo site.

Note that Wijmo does not send keys or any licensing information to any servers. It only checks the internal consistency of the key provided.

Parameters
Returns
void

setSelectionRange

setSelectionRange(e: any, start: number, end?: number): boolean

Sets the start and end positions of a selection in a text field.

This method is similar to the native setSelectionRange method in HTMLInputElement objects, except it checks for conditions that may cause exceptions (element not in the DOM, disabled, or hidden).

Parameters
Returns
boolean

setText

setText(e: HTMLElement, text: string): void

Sets the text content of an element.

Parameters
Returns
void

showPopup

showPopup(popup: HTMLElement, ref?: any, position?: PopupPosition | Boolean, fadeIn?: boolean, copyStyles?: any, hideOnScroll?: Function): any

Shows an element as a popup.

The popup element becomes a child of the body element, and is positioned with respect to reference rectangle according to the given PopupPosition.

The reference rectangle may be specified as one of the following:

HTMLElement
The bounding rectangle of the element.
MouseEvent
The bounding rectangle of the event's target element.
Rect
The given rectangle.
null
No reference rectangle; the popup is centered on the window.

Call the hidePopup method to hide the popup.

Parameters
Returns
any

toFixed

toFixed(value: number, prec: number, truncate: boolean): number

Rounds or truncates a number to a specified precision.

Parameters
Returns
number

toggleClass

toggleClass(e: Element, className: string, addOrRemove?: boolean): void

Adds or removes a class to or from an element.

Parameters
Returns
void

toHeaderCase

toHeaderCase(text: string): string

Converts a camel-cased string into a header-type string by capitalizing the first letter and adding spaces before uppercase characters preceded by lower-case characters.

For example, 'somePropertyName' becomes 'Some Property Name'.

Parameters
Returns
string

toPlainText

toPlainText(html: string): string

Converts an HTML string into plain text.

Parameters
Returns
string

tryCast

tryCast(value: any, type: any): any

Casts a value to a type if possible.

Parameters
Returns
any