wijmo 模块

参数

• e: Element

  Element that will have the class added.

• className: string

  Class (or space-separated list of classes) to add to the element.

返回值 void

var element = document.getElementById('someElement');
animate(function(pct) {
  element.style.opacity = pct;
}, 1000);

var element = document.getElementById('someElement');
if (this._animInterval) {
  clearInterval(this._animInterval);
}
var self = this;
self._animInterval = animate(function(pct) {
  element.style.opacity = pct;
  if (pct == 1) {
    self._animInterval = null;
  }
}, 1000);

参数

• apply: Function

  Callback function that modifies the document. The function takes a single parameter that represents a percentage.

• 可选 duration: number

  The duration of the animation, in milliseconds.

• 可选 step: number

  The interval between animation frames, in milliseconds.

返回值 any

An interval id that you can use to suspend the animation.

参数

• value: any

  Value supposed to be an array.

• 可选 nullOK: boolean

  Whether null values are acceptable.

返回值 any[]

The array passed in.

参数

• value: boolean

  Value supposed to be Boolean.

• 可选 nullOK: boolean

  Whether null values are acceptable.

返回值 boolean

The Boolean passed in.

参数

• value: any

  Array or ICollectionView.

• 可选 nullOK: boolean

  Whether null values are acceptable.

返回值 ICollectionView

The ICollectionView that was passed in or a CollectionView created from the array that was passed in.

参数

• value: Date

  Value supposed to be a Date.

• 可选 nullOK: boolean

  Whether null values are acceptable.

返回值 Date

The Date passed in.

参数

• value: number

  Value supposed to be a member of the enumeration.

• enumType: any

  Enumeration to test for.

• 可选 nullOK: boolean

  Whether null values are acceptable.

返回值 number

The value passed in.

参数

• value: any

  Value supposed to be a function.

• 可选 nullOK: boolean

  Whether null values are acceptable.

返回值 Function

The function passed in.

参数

• value: number

  Value supposed to be an integer.

• 可选 nullOK: boolean

  Whether null values are acceptable.

• 可选 positive: boolean

  Whether to accept only positive integers.

返回值 number

The number passed in.

参数

• value: number

  Value supposed to be numeric.

• 可选 nullOK: boolean

  Whether null values are acceptable.

• 可选 positive: boolean

  Whether to accept only positive numeric values.

返回值 number

The number passed in.

参数

• value: string

  Value supposed to be a string.

• 可选 nullOK: boolean

  Whether null values are acceptable.

返回值 string

The string passed in.

参数

• value: any

  Value to be checked.

• type: any

  Type of value expected.

• 可选 nullOK: boolean

  Whether null values are acceptable.

返回值 any

The value passed in.

参数

• condition: boolean

  Condition expected to be true.

• msg: string

  Message of the exception if the condition is not true.

返回值 void

参数

• value: any

  Value to convert.

• type: DataType

  DataType to convert the value to.

• 可选 format: string

  Format to use when converting to or from strings.

返回值 any

The converted value, or the original value if a conversion was not possible.

参数

• value: number

  Original value.

• min: number

  Minimum allowed value.

• max: number

  Maximum allowed value.

返回值 number

参数

• e: any

  Element where the search should start.

• selector: string

  A string containing a selector expression to match elements against.

返回值 Element

The closest ancestor that satisfies the selector, or null if not found.

参数

• e: any

  Element where the search should start.

• className: string

  A string containing the class name to match elements against.

返回值 Node

The closest ancestor that has the specified class name, or null if not found.

参数

• parent: any

  Parent element.

• child: any

  Child element.

• 可选 popup: boolean

  Whether to take Wijmo popups into account.

返回值 boolean

True if the parent element contains the child element.

参数

• dst: any

  The destination object.

• src: any

  The source object.

返回值 void

参数

• html: string

  HTML fragment to convert into an HTMLElement.

• 可选 appendTo: HTMLElement

  Optional HTMLElement to append the new element to.

返回值 HTMLElement

The new element.

参数

• e: HTMLInputElement

  The input element.

返回值 void

参数

• e: HTMLElement

  Element to enable or disable.

• value: boolean

  Whether to enable or disable the element.

返回值 void

参数

• text: string

  Text to escape.

返回值 string

An HTML-escaped version of the original string.

var data = { name: 'Joe', amount: 123456 };
var msg = wijmo.format('Hello {name}, you won {amount:n2}!', data);

var fmt = {
    count: 'count',
    when: {
        0: 'No items selected.',
        1: 'One item is selected.',
        2: 'A pair is selected.',
        'other': '{count:n0} items are selected.'
    }
}
fmt = JSON.stringify(fmt);
console.log(wijmo.format(fmt, { count: 0 })); // No items selected.
console.log(wijmo.format(fmt, { count: 1 })); // One item is selected.
console.log(wijmo.format(fmt, { count: 2 })); // A pair is selected.
console.log(wijmo.format(fmt, { count: 12 })); 12 items are selected.

var data = { name: 'Joe', amount: 123456 };
var msg = wijmo.format('Hello {name}, you won {amount:n2}!', data,
    function (data, name, fmt, val) {
        if (wijmo.isString(data[name])) {
            val = wijmo.escapeHtml(data[name]);
        }
        return val;
    }
);

参数

• format: string

  A composite format string.

• data: any

  The data object used to build the string.

• 可选 formatFunction: Function

  An optional function used to format items in context.

返回值 string

The formatted string.

返回值 HTMLElement

参数

• aggType: Aggregate

  Type of aggregate to calculate.

• items: any[]

  Array with the items to aggregate.

• 可选 binding: string

  Name of the property to aggregate on (in case the items are not simple values).

返回值 any

参数

• selector: any

  An element, a query selector string, or a jQuery object.

返回值 HTMLElement

参数

• e: Element

返回值 Rect

参数

• value: any

  Value to test.

返回值 DataType

A DataType value representing the type of the value passed in.

参数

• arr: any[]

  Array containing data items.

返回值 any[]

An array containing objects with the binding and type of each primitive property in the items found in the input array.

参数

• baseId: string

  String to use as a basis for generating the unique id.

返回值 string

返回值 string

参数

• e: Element

  Element to check.

• className: string

  Class to check for.

返回值 boolean

参数

• value: ICollectionView

  ICollectionView to check.

返回值 boolean

参数

• popup: HTMLElement

  Popup element to hide.

• 可选 remove: any

  Whether to remove the popup from the DOM or just to hide it. This parameter may be a boolean or a callback function that gets invoked after the popup has been removed from the DOM.

• 可选 fadeOut: boolean

  Whether to use a fade-out animation to make the popup disappear gradually.

返回值 any

An interval id that you can use to suspend the fade-out animation.

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

参数

• url: string

  String containing the URL to which the request is sent.

• 可选 settings: any

  An optional object used to configure the request.

返回值 XMLHttpRequest

The XMLHttpRequest object used to perform the request.

参数

• value: any

  Value to test.

返回值 boolean

参数

• value: any

  Value to test.

返回值 boolean

参数

• value: any

  Value to test.

返回值 boolean

参数

• obj: any

  Object to test.

返回值 boolean

参数

• value: any

  Value to test.

返回值 boolean

参数

• value: any

  Value to test.

返回值 boolean

参数

• value: string

  Value to test.

返回值 boolean

参数

• value: any

  Value to test.

返回值 boolean

参数

• value: any

  Value to test.

返回值 boolean

参数

• value: any

  Value to test.

返回值 boolean

参数

• value: any

  Value to test.

返回值 boolean

参数

• value: any

  Value to test.

返回值 boolean

参数

• e: any

返回值 Point

参数

• parent: HTMLElement

  Parent element.

• offset: number

  Offset to use when moving the focus (use zero to focus on the first focusable child).

返回值 boolean

True if the focus was set, false if a focusable element was not found.

参数

• e: Node

  Element to remove from the DOM tree.

返回值 Node

参数

• e: Element

  Element that will have the class removed.

• className: string

  Class (or space-separated list of classes) to remove from the element.

返回值 void

参数

• e: Element

  Element that will be updated.

• 可选 value: string

  Value of the aria label, or null to remove the label from the element.

返回值 void

参数

• e: Element

  Element that will be updated.

• name: string

  Name of the attribute to add or remove.

• 可选 value: any

  Value of the attribute, or null to remove the attribute from the element.

• 可选 keep: boolean

  Whether to keep original attribute if present.

返回值 void

参数

• e: any

  Element or array of elements whose style will be modified.

• css: any

  Object containing the style properties to apply to the element.

返回值 void

参数

• licenseKey: string

  String containing the license key to use in this application.

返回值 void

参数

• e: any

  HTMLInputElement or HTMLTextAreaElement to select.

• start: number

  Offset into the text field for the start of the selection.

• 可选 end: number

  Offset into the text field for the end of the selection.

返回值 boolean

参数

• e: HTMLElement

  Element that will have its content updated.

• text: string

  Plain text to be assigned to the element.

返回值 void

参数

• popup: HTMLElement

  Element to show as a popup.

• 可选 ref: any

  Reference element or rectangle used to position the popup.

• 可选 above: boolean

  Position popup above the reference rectangle if possible.

• 可选 fadeIn: boolean

  Use a fade-in animation to make the popup appear gradually.

• 可选 copyStyles: any

  Whether to copy font and color styles from the reference element, or an element to use as the style source.

返回值 any

An interval id that you can use to suspend the fade-in animation.

参数

• value: number

  Value to round or truncate.

• prec: number

  Number of decimal digits for the result.

• truncate: boolean

  Whether to truncate or round the original value.

返回值 number

参数

• text: string

  String to convert to header case.

返回值 string

参数

• html: string

  HTML string to convert to plain text.

返回值 string

A plain-text version of the string.

参数

• e: Element

  Element that will have the class added.

• className: string

  Class to add or remove.

• 可选 addOrRemove: boolean

  Whether to add or remove the class. If not provided, toggle the class.

返回值 void

参数

• value: any

  Value to cast.

• type: any

  Type or interface name to cast to.

返回值 any

The value passed in if the cast was successful, null otherwise.