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

Latest revision as of 15:07, 5 December 2023

Author	MatrixTSL
Version	0.1
Category	Data

Object Helper component

Component to help when dealing with Javascript objects.

Component Source Code

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

Please click here to view the component source code (Beta): FC_Comp_Source_WEBEXP_Object.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

GetKeys

	GetKeys
Returns a list of the JavaScript object's keys
- HANDLE	Object
The JavaSctipt object
- HANDLE	Return

GetValue

	GetValue
Gets the value for a key in a JavaScript object
- HANDLE	Object
The JavaScript object
- STRING	sKey
The key name
- HANDLE	Return

JSONToObject

	JSONToObject
Converts a JSON string to a JavaScript object
- STRING	Text
The JSON string to convert to a JavaScript object
- HANDLE	Return

NumberToObject

	NumberToObject
Converts a number to a JavaScript object
- LONG	Var
The number to convert to a JavaSctipt object
- HANDLE	Return

ObjectToFloat

	ObjectToFloat
Converts an object to a floating point value
- HANDLE	Object
The JavaScript object
- FLOAT	Return

ObjectToInteger

	ObjectToInteger
Converts an object to an integer
- HANDLE	Object
The JavaScript object
- LONG	Return

ObjectToJSON

	ObjectToJSON
Converts an object to a JSON string
- HANDLE	Object
The JavaScript object
- STRING	Return

ObjectToNumber

	ObjectToNumber
Converts an object to a number
- HANDLE	Object
The JavaScript object
- FLOAT	Return

ObjectToString

	ObjectToString
Converts an object to a string
- HANDLE	Object
The JavaScript object
- STRING	Return

SetValue

	SetValue
Sets the value of a key in a JavaScript object. Returns true if the key already exists.
- HANDLE	Object
The JavaScript object
- STRING	sKey
The key name
- HANDLE	Value
The value for the key
- BOOL	Return

StringToObject

	StringToObject
Converts a string to a JavaScript object
- STRING	Var
The string to convert to a JavaScript object
- HANDLE	Return

Property reference

	Properties

@@ Line 32: / Line 32: @@
 {{Fcfile|Web_Weather.fcsx|Web Weather Example}}
 ==Macro reference==
+===GetKeys===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetKeys'''
+|-
+| colspan="2" | Returns a list of the JavaScript object's keys&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Object
+|-
+| colspan="2" | The JavaSctipt object&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
 ===GetValue===
@@ Line 93: / Line 114: @@
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===ObjectToFloat===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ObjectToFloat'''
+|-
+| colspan="2" | Converts an object to a floating point value&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Object
+|-
+| colspan="2" | The JavaScript object&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===ObjectToInteger===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ObjectToInteger'''
+|-
+| colspan="2" | Converts an object to an integer&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Object
+|-
+| colspan="2" | The JavaScript object&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
@@ Line 130: / Line 189: @@
 | colspan="2" | The JavaScript object&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}