Difference between revisions of "Component: Array Helper ( Data)"

Latest revision as of 15:07, 5 December 2023

Author	MatrixTSL
Version	0.1
Category	Data

Array Helper component

Component designed to allow manipulation of Javascript arrays.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_WEBEXP_Array.fcsx

Please click here to view the component source code (Beta): FC_Comp_Source_WEBEXP_Array.fcsx

Detailed description

No detailed description exists yet for this component

Examples

Weather Example

Example program showcasing a number of components used together to collect data from a URL using fetch, before processing the data using the object helper and array helper components.

Web Weather Example

Macro reference

ArrayAddValue

	ArrayAddValue
Adds an element to a JavaScript array object. Returns the new size of the array.
- HANDLE	Object
The JavaScript object
- ULONG	Index
The element index
- HANDLE	Element
The new element to add to the array
- LONG	Return

ArrayGetLength

	ArrayGetLength
Gets the length of a JavaScript array object
- HANDLE	Object
The JavaScript object
- LONG	Return

ArrayGetValue

	ArrayGetValue
Gets the value of an element in a JavaScript array object
- HANDLE	Object
The JavaScript object
- ULONG	Index
The element index
- HANDLE	Return

ArrayIndexOf

	ArrayIndexOf
Gets the index of a value within a JavaScript array object
- HANDLE	Object
The JavaScript object
- HANDLE	Value
The value to look for within the array
- INT	Start
The index to start the search (use negative numbers to search backwards)
- LONG	Return

ArrayParse

	ArrayParse
Parse a JavaScript array object by calling the macro for each element in the array.
- HANDLE	Object
The JavaScript object
- VOID	Return

ArrayRemoveValues

	ArrayRemoveValues
Removes elements from a JavaScript array object. Returns the new size of the array.
- HANDLE	Object
The JavaScript object
- ULONG	Index
The element index
- ULONG	Count
The number of values to remove from the array
- LONG	Return

ArraySetValue

	ArraySetValue
Sets the value of an element in a JavaScript array object
- HANDLE	Object
The JavaScript object
- ULONG	Index
The element index
- HANDLE	Value
The new value for the array element
- VOID	Return

IsArray

	IsArray
Returns true if the JavaScript object is an array
- HANDLE	Object
The JavaScript object
- BOOL	Return

Property reference

	Properties
	ParseArray macro
Allows an easy way to parse an array element by element

@@ Line 27: / Line 27: @@
 ==Examples==
-''<span style="color:red;">No additional examples</span>''
+===Weather Example===
+Example program showcasing a number of components used together to collect data from a URL using fetch, before processing the data using the object helper and array helper components.
+{{Fcfile|Web_Weather.fcsx|Web Weather Example}}
 ==Macro reference==