Json

Json

SplashKit Json allows you to create and read JSON objects.

Functions

Create Json  {</>}

Note

This function is overloaded. The following versions exist:

• Create Json ()  {</>}
• Create Json (json_string: string)

Create Json  {</>}

The empty Json object returned can be filled with data and read by the functions and procedures prefixed with json_add_ and json_read_

Return Type: Json

Returns: Returns an empty Json object.

Signatures:

C++

json create_json()

C#

public static Json SplashKit.CreateJson();
public Json();

Python

def create_json():

Pascal

function CreateJson(): Json

Usage:  {</>}

See Implementations in Guides

• Using JSON in SplashKit
• How to make a RESTful API call using SplashKit

---

Create Json

string json_string must be valid JSON. The Json object returned can be filled with data and read by the functions and procedures prefixed with json_add_ and json_read_

Parameters:

Name	Type	Description
json_string	String	The JSON formatted String to be converted to a Json object.

Return Type: Json

Returns: Returns a Json object filled with data from the parameter String.

Signatures:

C++

json create_json(string json_string)

C#

public static Json SplashKit.CreateJson(string jsonString);
public Json(string jsonString);

Python

def create_json_from_string(json_string):

Pascal

function CreateJson(jsonString: String): Json

---

Free All Json  {</>}

Releases all of the Json objects which have been loaded.

Signatures:

C++

void free_all_json()

C#

public static void Json.FreeAll();
public static void SplashKit.FreeAllJson();

Python

def free_all_json():

Pascal

procedure FreeAllJson()

Usage:  {</>}

See Implementations in Guides

• Using JSON in SplashKit

---

Free Json  {</>}

Frees the SplashKit resources associated with the Json object.

Parameters:

Name	Type	Description
j	Json	The Json object whose resources should be released.

Signatures:

C++

void free_json(json j)

C#

public void Json.Free();
public static void SplashKit.FreeJson(Json j);

Python

def free_json(j):

Pascal

procedure FreeJson(j: Json)

Usage:  {</>}

See Implementations in Guides

• Using JSON in SplashKit

---

Json Count Keys

Returns the count of keys in the top-level Json object.

Parameters:

Name	Type	Description
j	Json	The Json object to count keys.

Return Type: Integer

Returns: The count of keys in the top-level Json object.

Signatures:

C++

int json_count_keys(json j)

C#

public int Json.CountKeys();
public static int SplashKit.JsonCountKeys(Json j);

Python

def json_count_keys(j):

Pascal

function JsonCountKeys(j: Json): Integer

---

Json From Color

Converts a Color to a Json object.

Parameters:

Name	Type	Description
clr	Color	The Color to convert to Json.

Return Type: Json

Returns: The Color serialized into a Json object.

Signatures:

C++

json json_from_color(color clr)

C#

public static Json SplashKit.JsonFromColor(Color clr);

Python

def json_from_color(clr):

Pascal

function JsonFromColor(clr: Color): Json

---

Json From File  {</>}

Reads a Json object from a JSON string stored in Resources/json/filename and loads the data into the returned Json object.

Parameters:

Name	Type	Description
filename	String	The filename of the file to be written to Resources/json/.

Return Type: Json

Returns: Returns the Json object loaded from the JSON file in filename.

Signatures:

C++

json json_from_file(const string &filename)

C#

public static Json Json.FromFile(string filename);
public static Json SplashKit.JsonFromFile(string filename);

Python

def json_from_file(filename):

Pascal

function JsonFromFile(const filename: String): Json

Usage:  {</>}

See Implementations in Guides

• Using JSON in SplashKit
• Using JSON in SplashKit

---

Json From String  {</>}

Reads a Json object from a String in the JSON format.

Parameters:

Name	Type	Description
j_string	String	A String in the JSON format.

Return Type: Json

Returns: Returns a Json object loaded with data from string j_string.

Signatures:

C++

json json_from_string(const string &j_string)

C#

public static Json Json.FromJsonString(string jString);
public static Json SplashKit.JsonFromString(string jString);

Python

def json_from_string(j_string):

Pascal

function JsonFromString(const jString: String): Json

Usage:  {</>}

See Implementations in Guides

• How to make a RESTful API call using SplashKit
• How to make a RESTful API call using SplashKit

---

Json Has Key  {</>}

Checks if the Json object contains the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object to check for the given key.
key	String	The String key to be checked.

Return Type: Boolean

Returns: Returns true if the json j object contains a key for String key.

Signatures:

C++

bool json_has_key(json j, string key)

C#

public bool Json.HasKey(string key);
public static bool SplashKit.JsonHasKey(Json j, string key);

Python

def json_has_key(j, key):

Pascal

function JsonHasKey(j: Json; key: String): Boolean

Usage:  {</>}

See Implementations in Guides

• Using JSON in SplashKit

---

Json Read Array  {</>}

Note

This function is overloaded. The following versions exist:

• Json Read Array (j: json, key: string, out_result: vector)
• Json Read Array (j: json, key: string, out_result: vector)
• Json Read Array (j: json, key: string, out_result: vector)  {</>}
• Json Read Array (j: json, key: string, out_result: vector)

Json Read Array

Reads an array of Double values from the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object from which data will be returned for the given key.
key	String	The String key used to find data in the Json object.
out_result	Vector	The array which will be filled with the data stored for String key.

Signatures:

C++

void json_read_array(json j, string key, vector<double> &out_result)

C#

public void Json.ReadArray(string key, ref List<double> outResult);
public static void SplashKit.JsonReadArray(Json j, string key, ref List<double> outResult);

Python

def json_read_array_of_double(j, key, out_result):

Pascal

procedure JsonReadArray(j: Json; key: String; var outResult: ArrayOfDouble)

---

Json Read Array

Reads an array of Json object values from the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object from which data will be returned for the given key.
key	String	The String key used to find data in the Json object.
out_result	Vector	The array which will be filled with the data stored for String key.

Signatures:

C++

void json_read_array(json j, string key, vector<json> &out_result)

C#

public void Json.ReadArray(string key, ref List<Json> outResult);
public static void SplashKit.JsonReadArray(Json j, string key, ref List<Json> outResult);

Python

def json_read_array_of_json(j, key, out_result):

Pascal

procedure JsonReadArray(j: Json; key: String; var outResult: ArrayOfJson)

---

Json Read Array  {</>}

Reads an array of String values from the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object from which data will be returned for the given key.
key	String	The String key used to find data in the Json object.
out_result	Vector	The array which will be filled with the data stored for String key.

Signatures:

C++

void json_read_array(json j, string key, vector<string> &out_result)

C#

public void Json.ReadArray(string key, ref List<string> outResult);
public static void SplashKit.JsonReadArray(Json j, string key, ref List<string> outResult);

Python

def json_read_array_of_string(j, key, out_result):

Pascal

procedure JsonReadArray(j: Json; key: String; var outResult: ArrayOfString)

Usage:  {</>}

See Implementations in Guides

• Using JSON in SplashKit

---

Json Read Array

Reads an array of Boolean values from the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object from which data will be returned for the given key.
key	String	The String key used to find data in the Json object.
out_result	Vector	The array which will be filled with the data stored for String key.

Signatures:

C++

void json_read_array(json j, string key, vector<bool> &out_result)

C#

public void Json.ReadArray(string key, ref List<bool> outResult);
public static void SplashKit.JsonReadArray(Json j, string key, ref List<bool> outResult);

Python

def json_read_array_of_bool(j, key, out_result):

Pascal

procedure JsonReadArray(j: Json; key: String; var outResult: ArrayOfBoolean)

---

Json Read Bool

Reads a Boolean value from the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object from which data will be returned for the given key.
key	String	The String key used to find data in the Json object.

Return Type: Boolean

Returns: Returns the Boolean value stored at the String key.

Signatures:

C++

bool json_read_bool(json j, string key)

C#

public bool Json.ReadBool(string key);
public static bool SplashKit.JsonReadBool(Json j, string key);

Python

def json_read_bool(j, key):

Pascal

function JsonReadBool(j: Json; key: String): Boolean

---

Json Read Number

Reads a Float value from the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object from which data will be returned for the given key.
key	String	The String key used to find data in the Json object.

Return Type: Float

Returns: Returns the Float value stored at the String key.

Signatures:

C++

float json_read_number(json j, string key)

C#

public float Json.ReadNumber(string key);
public static float SplashKit.JsonReadNumber(Json j, string key);

Python

def json_read_number(j, key):

Pascal

function JsonReadNumber(j: Json; key: String): Single

---

Json Read Number As Double

Reads a Double value from the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object from which data will be returned for the given key.
key	String	The String key used to find data in the Json object.

Return Type: Double

Returns: Returns the Double value stored at the String key.

Signatures:

C++

double json_read_number_as_double(json j, string key)

C#

public double Json.ReadDouble(string key);
public static double SplashKit.JsonReadNumberAsDouble(Json j, string key);

Python

def json_read_number_as_double(j, key):

Pascal

function JsonReadNumberAsDouble(j: Json; key: String): Double

---

Json Read Number As Int  {</>}

Reads a integer value from the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object from which data will be returned for the given key.
key	String	The String key used to find data in the Json object.

Return Type: Integer

Returns: Returns the integer value stored at the String key.

Signatures:

C++

int json_read_number_as_int(json j, string key)

C#

public int Json.ReadInteger(string key);
public static int SplashKit.JsonReadNumberAsInt(Json j, string key);

Python

def json_read_number_as_int(j, key):

Pascal

function JsonReadNumberAsInt(j: Json; key: String): Integer

Usage:  {</>}

See Implementations in Guides

• Using JSON in SplashKit
• Using JSON in SplashKit
• How to make a RESTful API call using SplashKit

---

Json Read Object  {</>}

Reads a Json object value from the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object from which data will be returned for the given key.
key	String	The String key used to find data in the Json object.

Return Type: Json

Returns: Returns the Json object value stored at the String key.

Signatures:

C++

json json_read_object(json j, string key)

C#

public Json Json.ReadObject(string key);
public static Json SplashKit.JsonReadObject(Json j, string key);

Python

def json_read_object(j, key):

Pascal

function JsonReadObject(j: Json; key: String): Json

Usage:  {</>}

See Implementations in Guides

• Using JSON in SplashKit
• Using JSON in SplashKit

---

Json Read String  {</>}

Reads a String value from the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object from which data will be returned for the given key.
key	String	The String key used to find data in the Json object.

Return Type: String

Returns: Returns the String value stored at the String key.

Signatures:

C++

string json_read_string(json j, string key)

C#

public string Json.ReadString(string key);
public static string SplashKit.JsonReadString(Json j, string key);

Python

def json_read_string(j, key):

Pascal

function JsonReadString(j: Json; key: String): String

Usage:  {</>}

See Implementations in Guides

• Using JSON in SplashKit
• How to make a RESTful API call using SplashKit

---

Json Set Array  {</>}

Note

This function is overloaded. The following versions exist:

• Json Set Array (j: json, key: string, value: vector)  {</>}
• Json Set Array (j: json, key: string, value: vector)
• Json Set Array (j: json, key: string, value: vector)
• Json Set Array (j: json, key: string, value: vector)

Json Set Array  {</>}

Adds an array of String values to the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object where data will be inserted for the given key.
key	String	The String key where data will be stored in the Json object.
value	Vector	The value to be inserted into the Json object.

Signatures:

C++

void json_set_array(json j, string key, vector<string> value)

C#

public void Json.AddArray(string key, List<string> value);
public static void SplashKit.JsonSetArray(Json j, string key, List<string> value);

Python

def json_set_array_of_string(j, key, value):

Pascal

procedure JsonSetArray(j: Json; key: String; value: ArrayOfString)

Usage:  {</>}

See Implementations in Guides

• Using JSON in SplashKit

---

Json Set Array

Adds an array of Double values to the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object where data will be inserted for the given key.
key	String	The String key where data will be stored in the Json object.
value	Vector	The value to be inserted into the Json object.

Signatures:

C++

void json_set_array(json j, string key, vector<double> value)

C#

public void Json.AddArray(string key, List<double> value);
public static void SplashKit.JsonSetArray(Json j, string key, List<double> value);

Python

def json_set_array_of_double(j, key, value):

Pascal

procedure JsonSetArray(j: Json; key: String; value: ArrayOfDouble)

---

Json Set Array

Adds an array of Boolean values to the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object where data will be inserted for the given key.
key	String	The String key where data will be stored in the Json object.
value	Vector	The value to be inserted into the Json object.

Signatures:

C++

void json_set_array(json j, string key, vector<bool> value)

C#

public void Json.AddArray(string key, List<bool> value);
public static void SplashKit.JsonSetArray(Json j, string key, List<bool> value);

Python

def json_set_array_of_bool(j, key, value):

Pascal

procedure JsonSetArray(j: Json; key: String; value: ArrayOfBoolean)

---

Json Set Array

Adds an array of Json object values to the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object where data will be inserted for the given key.
key	String	The String key where data will be stored in the Json object.
value	Vector	The value to be inserted into the Json object.

Signatures:

C++

void json_set_array(json j, string key, vector<json> value)

C#

public void Json.AddArray(string key, List<Json> value);
public static void SplashKit.JsonSetArray(Json j, string key, List<Json> value);

Python

def json_set_array_of_json(j, key, value):

Pascal

procedure JsonSetArray(j: Json; key: String; value: ArrayOfJson)

---

Json Set Bool  {</>}

Adds a Boolean value to the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object where data will be inserted for the given key.
key	String	The String key where data will be stored in the Json object.
value	Boolean	The value to be inserted into the Json object.

Signatures:

C++

void json_set_bool(json j, string key, bool value)

C#

public void Json.AddBool(string key, bool value);
public static void SplashKit.JsonSetBool(Json j, string key, bool value);

Python

def json_set_bool(j, key, value):

Pascal

procedure JsonSetBool(j: Json; key: String; value: Boolean)

Usage:  {</>}

See Implementations in Guides

• Using JSON in SplashKit

---

Json Set Number  {</>}

Note

This function is overloaded. The following versions exist:

• Json Set Number (j: json, key: string, value: int)  {</>}
• Json Set Number (j: json, key: string, value: double)
• Json Set Number (j: json, key: string, value: float)

Json Set Number  {</>}

Adds an Integer value to the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object where data will be inserted for the given key.
key	String	The String key where data will be stored in the Json object.
value	Integer	The value to be inserted into the Json object.

Signatures:

C++

void json_set_number(json j, string key, int value)

C#

public void Json.AddNumber(string key, int value);
public static void SplashKit.JsonSetNumber(Json j, string key, int value);

Python

def json_set_number_integer(j, key, value):

Pascal

procedure JsonSetNumber(j: Json; key: String; value: Integer)

Usage:  {</>}

See Implementations in Guides

• Using JSON in SplashKit
• How to make a RESTful API call using SplashKit

---

Json Set Number

Adds a Double value to the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object where data will be inserted for the given key.
key	String	The String key where data will be stored in the Json object.
value	Double	The value to be inserted into the Json object.

Signatures:

C++

void json_set_number(json j, string key, double value)

C#

public void Json.AddNumber(string key, double value);
public static void SplashKit.JsonSetNumber(Json j, string key, double value);

Python

def json_set_number_double(j, key, value):

Pascal

procedure JsonSetNumber(j: Json; key: String; value: Double)

---

Json Set Number

Adds a Float value to the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object where data will be inserted for the given key.
key	String	The String key where data will be stored in the Json object.
value	Float	The value to be inserted into the Json object.

Signatures:

C++

void json_set_number(json j, string key, float value)

C#

public void Json.AddNumber(string key, float value);
public static void SplashKit.JsonSetNumber(Json j, string key, float value);

Python

def json_set_number_float(j, key, value):

Pascal

procedure JsonSetNumber(j: Json; key: String; value: Single)

---

Json Set Object  {</>}

Adds a Json object to the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object where data will be inserted for the given key.
key	String	The String key where data will be stored in the Json object.
obj	Json	The value to be inserted into the Json object.

Signatures:

C++

void json_set_object(json j, string key, json obj)

C#

public void Json.AddObject(string key, Json obj);
public static void SplashKit.JsonSetObject(Json j, string key, Json obj);

Python

def json_set_object(j, key, obj):

Pascal

procedure JsonSetObject(j: Json; key: String; obj: Json)

Usage:  {</>}

See Implementations in Guides

• Using JSON in SplashKit

---

Json Set String  {</>}

Adds a String value to the Json object for the given String key.

Parameters:

Name	Type	Description
j	Json	The Json object where data will be inserted for the given key.
key	String	The String key where data will be stored in the Json object.
value	String	The value to be inserted into the Json object.

Signatures:

C++

void json_set_string(json j, string key, string value)

C#

public void Json.AddString(string key, string value);
public static void SplashKit.JsonSetString(Json j, string key, string value);

Python

def json_set_string(j, key, value):

Pascal

procedure JsonSetString(j: Json; key: String; value: String)

Usage:  {</>}

See Implementations in Guides

• Using JSON in SplashKit
• How to make a RESTful API call using SplashKit

---

Json To Color

Converts a Json object to a Color object.

Parameters:

Name	Type	Description
j	Json	The Json to convert to a Color.

Return Type: Color

Returns: The Color deserialized from the Json object.

Signatures:

C++

color json_to_color(json j)

C#

public static Color SplashKit.JsonToColor(Json j);

Python

def json_to_color(j):

Pascal

function JsonToColor(j: Json): Color

---

Json To File  {</>}

Writes the Json object to a JSON string stored in Resources/json/filename.

Parameters:

Name	Type	Description
j	Json	The Json object to be written to file.
filename	String	The filename of the file to be stored in Resources/json/

Signatures:

C++

void json_to_file(json j, const string &filename)

C#

public static void Json.ToFile(Json j, string filename);
public static void SplashKit.JsonToFile(Json j, string filename);

Python

def json_to_file(j, filename):

Pascal

procedure JsonToFile(j: Json; const filename: String)

Usage:  {</>}

See Implementations in Guides

• Using JSON in SplashKit

---

Json To String

Converts and returns the Json object as a String.

Parameters:

Name	Type	Description
j	Json	The Json object to be converted to a String.

Return Type: String

Returns: Returns the Json object as a String.

Signatures:

C++

string json_to_string(json j)

C#

public static string Json.ToJsonString(Json j);
public static string SplashKit.JsonToString(Json j);

Python

def json_to_string(j):

Pascal

function JsonToString(j: Json): String

---

Types

Json

The Json type is used to refer to objects in the JSON format that can be manipulated by the SplashKit Json functions and procedures.

All Json objects are:

• created with create_json() or create_json(string s) or json_from_string(string s) or json_from_file(json j)

• and must be released using free_json() (to release a specific Json object) or free_all_json() (to release all loaded Json objects).

---