QJsonArray

The QJsonArray class encapsulates a JSON array. More

Inheritance diagram of PySide6.QtCore.QJsonArray

Synopsis

Functions

Static functions

Detailed Description

A JSON array is a list of values. The list can be manipulated by inserting and removing QJsonValue ‘s from the array.

A QJsonArray can be converted to and from a QVariantList . You can query the number of entries with size() , insert() , and removeAt() entries from it and iterate over its content using the standard C++ iterator pattern.

QJsonArray is an implicitly shared class and shares the data with the document it has been created from as long as it is not being modified.

You can convert the array to and from text based JSON through QJsonDocument .

See also

JSON Support in Qt JSON Save Game Example

class PySide6.QtCore.QJsonArray

PySide6.QtCore.QJsonArray(other)

Parameters

otherPySide6.QtCore.QJsonArray

Creates an empty array.

PySide6.QtCore.QJsonArray.append(value)
Parameters

valuePySide6.QtCore.QJsonValue

Inserts value at the end of the array.

See also

prepend() insert()

PySide6.QtCore.QJsonArray.at(i)
Parameters

iqsizetype

Return type

PySide6.QtCore.QJsonValue

Returns a QJsonValue representing the value for index i.

The returned QJsonValue is Undefined, if i is out of bounds.

PySide6.QtCore.QJsonArray.contains(element)
Parameters

elementPySide6.QtCore.QJsonValue

Return type

bool

Returns true if the array contains an occurrence of value, otherwise false.

See also

count()

PySide6.QtCore.QJsonArray.count()
Return type

qsizetype

Same as size() .

See also

size()

PySide6.QtCore.QJsonArray.empty()
Return type

bool

This function is provided for STL compatibility. It is equivalent to isEmpty() and returns true if the array is empty.

PySide6.QtCore.QJsonArray.first()
Return type

PySide6.QtCore.QJsonValue

Returns the first value stored in the array.

Same as at(0).

See also

at()

static PySide6.QtCore.QJsonArray.fromStringList(list)
Parameters

list – list of strings

Return type

PySide6.QtCore.QJsonArray

Converts the string list list to a QJsonArray .

The values in list will be converted to JSON values.

static PySide6.QtCore.QJsonArray.fromVariantList(list)
Parameters

list

Return type

PySide6.QtCore.QJsonArray

Converts the variant list list to a QJsonArray .

The QVariant values in list will be converted to JSON values.

Note

Conversion from QVariant is not completely lossless. Please see the documentation in fromVariant() for more information.

PySide6.QtCore.QJsonArray.insert(i, value)
Parameters
PySide6.QtCore.QJsonArray.isEmpty()
Return type

bool

Returns true if the object is empty. This is the same as size() == 0.

See also

size()

PySide6.QtCore.QJsonArray.last()
Return type

PySide6.QtCore.QJsonValue

Returns the last value stored in the array.

Same as at(size() - 1).

See also

at()

PySide6.QtCore.QJsonArray.__ne__(other)
Parameters

otherPySide6.QtCore.QJsonArray

Return type

bool

Returns true if this array is not equal to other.

PySide6.QtCore.QJsonArray.__add__(v)
Parameters

vPySide6.QtCore.QJsonValue

Return type

PySide6.QtCore.QJsonArray

Returns an array that contains all the items in this array followed by the provided value.

See also

operator+=()

PySide6.QtCore.QJsonArray.__iadd__(v)
Parameters

vPySide6.QtCore.QJsonValue

Return type

PySide6.QtCore.QJsonArray

Appends value to the array, and returns a reference to the array itself.

See also

append() operator

PySide6.QtCore.QJsonArray.__lshift__(v)
Parameters

vPySide6.QtCore.QJsonValue

Return type

PySide6.QtCore.QJsonArray

PySide6.QtCore.QJsonArray.__eq__(other)
Parameters

otherPySide6.QtCore.QJsonArray

Return type

bool

Returns true if this array is equal to other.

PySide6.QtCore.QJsonArray.operator[](i)
Parameters

iqsizetype

Return type

PySide6.QtCore.QJsonValue

This is an overloaded function.

Same as at() .

PySide6.QtCore.QJsonArray.pop_back()

This function is provided for STL compatibility. It is equivalent to removeLast() . The array must not be empty. If the array can be empty, call isEmpty() before calling this function.

PySide6.QtCore.QJsonArray.pop_front()

This function is provided for STL compatibility. It is equivalent to removeFirst() . The array must not be empty. If the array can be empty, call isEmpty() before calling this function.

PySide6.QtCore.QJsonArray.prepend(value)
Parameters

valuePySide6.QtCore.QJsonValue

Inserts value at the beginning of the array.

This is the same as insert(0, value) and will prepend value to the array.

See also

append() insert()

PySide6.QtCore.QJsonArray.push_back(t)
Parameters

tPySide6.QtCore.QJsonValue

This function is provided for STL compatibility. It is equivalent to append(value) and will append value to the array.

PySide6.QtCore.QJsonArray.push_front(t)
Parameters

tPySide6.QtCore.QJsonValue

This function is provided for STL compatibility. It is equivalent to prepend(value) and will prepend value to the array.

PySide6.QtCore.QJsonArray.removeAt(i)
Parameters

iqsizetype

Removes the value at index position i. i must be a valid index position in the array (i.e., 0 <= i < size()).

See also

insert() replace()

PySide6.QtCore.QJsonArray.removeFirst()

Removes the first item in the array. Calling this function is equivalent to calling removeAt(0). The array must not be empty. If the array can be empty, call isEmpty() before calling this function.

PySide6.QtCore.QJsonArray.removeLast()

Removes the last item in the array. Calling this function is equivalent to calling removeAt(size() - 1). The array must not be empty. If the array can be empty, call isEmpty() before calling this function.

PySide6.QtCore.QJsonArray.replace(i, value)
Parameters

Replaces the item at index position i with value. i must be a valid index position in the array (i.e., 0 <= i < size()).

See also

operator[]() removeAt()

PySide6.QtCore.QJsonArray.size()
Return type

qsizetype

Returns the number of values stored in the array.

PySide6.QtCore.QJsonArray.swap(other)
Parameters

otherPySide6.QtCore.QJsonArray

Swaps the array other with this. This operation is very fast and never fails.

PySide6.QtCore.QJsonArray.takeAt(i)
Parameters

iqsizetype

Return type

PySide6.QtCore.QJsonValue

Removes the item at index position i and returns it. i must be a valid index position in the array (i.e., 0 <= i < size()).

If you don’t use the return value, removeAt() is more efficient.

See also

removeAt()

PySide6.QtCore.QJsonArray.toVariantList()
Return type

Converts this object to a QVariantList .

Returns the created map.