tinymce.util.Tools
This class contains various utlity functions. These are also exposed directly on the tinymce namespace.
Summary
Methods
Name | Summary | Defined by |
---|---|---|
Performs an iteration of all items in a collection such as an object or array. This method will execute the
callback function for each item in the collection, if the callback returns false the iteration will terminate.
The callback has the following format: |
||
Splits a string but removes the whitespace before and after each value. |
||
Filters out items from the input array by calling the specified function for each item. If the function returns false the item will be excluded if it returns true it will be included. |
||
JavaScript does not protect hasOwnProperty method, so it is possible to overwrite it. This is
an object independent version.
Checks if the input object |
||
Returns an index of the item or -1 if item is not present in the array. |
||
Checks if a object is of a specific type for example an array. |
||
Returns true/false if the object is an array or not. |
||
Makes a name/object map out of an array with names. |
||
Creates a new array by the return value of each iteration function call. This enables you to convert one array list into another. |
||
Resolves a string and returns the object from a specific structure. |
||
Converts the specified object into a real JavaScript array. |
||
Removes whitespace from the beginning and end of a string. |
||
Executed the specified function for each item in a object tree. |
Methods
each()
each(o: Object, cb: Function, s: Object)
Performs an iteration of all items in a collection such as an object or array. This method will execute the
callback function for each item in the collection, if the callback returns false the iteration will terminate.
The callback has the following format: cb(value, key_or_index)
.
explode()
explode(s: String, d: String)
Splits a string but removes the whitespace before and after each value.
grep()
grep(a: Array, f: Function): Array
Filters out items from the input array by calling the specified function for each item. If the function returns false the item will be excluded if it returns true it will be included.
Examples
// Filter out some items, this will return an array with 4 and 5
const items = tinymce.grep([ 1,2,3,4,5 ], (v) => v > 3);
hasOwnProperty()
hasOwnProperty(obj: Object, prop: String): Boolean
JavaScript does not protect hasOwnProperty method, so it is possible to overwrite it. This is
an object independent version.
Checks if the input object obj
has the property prop
.
inArray()
inArray(item: any, arr: Array): Number
Returns an index of the item or -1 if item is not present in the array.
is()
is(obj: Object, type: String): Boolean
Checks if a object is of a specific type for example an array.
makeMap()
makeMap(items: Array | String, delim: String, map: Object): Object
Makes a name/object map out of an array with names.
map()
map(array: Array, callback: Function): Array
Creates a new array by the return value of each iteration function call. This enables you to convert one array list into another.
resolve()
resolve(n: String, o: Object): Object
Resolves a string and returns the object from a specific structure.