Class Util

Index

Properties

Methods

Properties

public static emptyImageUrl: string

Data URI string containing a base64-encoded empty GIF image. Used as a hack to free memory from unused images on WebKit-powered mobile devices (by setting image src to this string).

Methods

public static bind(fn: T, obj: any): T

Returns a function which executes function fn with the given scope obj (so that this keyword refers to obj inside the function code). Has an L.bind shortcut.

Parameters

  • fn: T
  • obj: any

Returns

T

public static extend(dest: any, sources?: Array<any>): any

Merges the properties of the src object (or multiple objects) into dest object and returns the latter. Has an L.extend shortcut.

Parameters

  • dest: any
  • sources?: Array<any> optional

Returns

any

public static falseFn(): () => boolean

Returns a function which always returns false.

Returns

() => boolean

public static formatNum(num: number, digits: number): number

Returns the number num rounded to digits decimals.

Parameters

  • num: number
  • digits: number

Returns

number

public static getParamString(obj: any): string

Converts an object into a parameter URL string, e.g. {a: "foo", b: "bar"} translates to '?a=foo&b=bar'.

Parameters

  • obj: any

Returns

string

public static isArray(obj: any): boolean

Returns true if the given object is an array.

Parameters

  • obj: any

Returns

boolean

public static limitExecByInterval(fn: T, time: number, context?: any): T

Returns a wrapper around the function fn that makes sure it's called not more often than a certain time interval time, but as fast as possible otherwise (for example, it is used for checking and requesting new tiles while dragging the map), optionally passing the scope (context) in which the function will be called.

Parameters

  • fn: T
  • time: number
  • context?: any optional

Returns

T

public static setOptions(obj: any, options: any): any

Merges the given properties to the options of the obj object, returning the resulting options. See Class options. Has an L.setOptions shortcut.

Parameters

  • obj: any
  • options: any

Returns

any

public static splitWords(str: string): Array<string>

Trims and splits the string on whitespace and returns the array of parts.

Parameters

  • str: string

Returns

Array<string>

public static stamp(obj: any): string

Applies a unique key to the object and returns that key. Has an L.stamp shortcut.

Parameters

  • obj: any

Returns

string

public static template(str: string, data: any): string

Simple templating facility, creates a string by applying the values of the data object of a form {a: 'foo', b: 'bar', …} to a template string of the form 'Hello {a}, {b}' — in this example you will get 'Hello foo, bar'.

Parameters

  • str: string
  • data: any

Returns

string

public static trim(str: string): boolean

Trims the whitespace from both ends of the string and returns the result.

Parameters

  • str: string

Returns

boolean