json.fields: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
(New page: ==Function json.fields== '''Introduced in MapTool 1.3b49''' Returns the fields (keys) for a json object or the indexes for a json array as a string list. The type of the value returned...)
 
No edit summary
 
(10 intermediate revisions by 6 users not shown)
Line 1: Line 1:
==Function json.fields==
{{MacroFunction
|name=json.fields
|version=1.3b49
|description=
Returns the fields (keys) for a [[JSON Object]] or the indexes for a [[JSON Array]] as a string list. The type of the value returned depends on the delimiter parameter.


<u>Note</u>: Because [[JSON Object]]s are unordered, ''json.fields'' will not reflect the order they were set in.


|usage=
<syntaxhighlight lang="mtmacro" line>
json.fields(jobj)
</syntaxhighlight>
<syntaxhighlight lang="mtmacro" line>
json.fields(jobj, delim)
</syntaxhighlight>


'''Introduced in MapTool 1.3b49'''
'''Parameters'''
* {{code|delim}} =
** {{code|unspecified}}: a standard [[Macros:string list|string list]] is returned, with its default {{code|","}} delimiter.
** {{code|"json"}}: a [[JSON Array]] is returned.
** {{code|"x"}}: a [[Macros:string list|string list]] is returned with {{code|"x"}} used as a delimiter.


Returns the fields (keys) for a json object or the indexes for a json array as a string list. The type of the value returned depends on the delimiter parameter.
|example=
* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used.
<syntaxhighlight lang="mtmacro" line>
* If the delimiter ''"json"'' then a [[Macros:json array|json array]] is returned.
[h: a=json.fromStrProp("a=1;b=44;c=12")]
* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in.
[r: json.fields(a)]
</syntaxhighlight>
Returns
  a,b,c




<syntaxhighlight lang="mtmacro" line>
[h: a=json.fromList("a,1,g,4")]
[r: json.fields(a,";")]
</syntaxhighlight>
Returns
  0;1;2;3


===Usage===
<source lang="mtmacro" line>
[h: strList = json.fields(jobj)]
[h: strList = json.fields(jobj, delim)]
[h: jobj = json.fields(jobj, 'json')]
</source>
===Examples===
<source lang="mtmacro" line>
  [h:a=json.fromStrProp("a=1;b=44;c=12")] [r:json.fields(a)]
  [h:a=json.fromList("a,1,g,4")][r:json.fields(a)]
  [h:a=json.fromStrProp("a=1;b=44;c=12")] [r:json.fields(a, "json")]
</source>


<syntaxhighlight lang="mtmacro" line>
[h: a=json.fromStrProp("a=1;b=44;c=12")]
[r: json.fields(a, "json")]
</syntaxhighlight>
Returns
Returns
  a,c,b
   ["a","b","c"]
  0,1,2,3
}}
   ["a","c","b"]
[[Category:JSON Function]]

Latest revision as of 23:59, 15 March 2023

json.fields() Function

• Introduced in version 1.3b49
Returns the fields (keys) for a JSON Object or the indexes for a JSON Array as a string list. The type of the value returned depends on the delimiter parameter. Note: Because JSON Objects are unordered, json.fields will not reflect the order they were set in.

Usage

json.fields(jobj)
json.fields(jobj, delim)

Parameters

  • delim =
    • unspecified: a standard string list is returned, with its default "," delimiter.
    • "json": a JSON Array is returned.
    • "x": a string list is returned with "x" used as a delimiter.

Example

[h: a=json.fromStrProp("a=1;b=44;c=12")]
[r: json.fields(a)]

Returns 

 a,b,c



[h: a=json.fromList("a,1,g,4")]
[r: json.fields(a,";")]

Returns 

 0;1;2;3



[h: a=json.fromStrProp("a=1;b=44;c=12")]
[r: json.fields(a, "json")]

Returns

["a","b","c"]
Retrieved from "https://rptools.hyperbooks.com/index.php?title=json.fields&oldid=35208"