JsonArray JavaScript Reference Documentation

JsonArray

Current Version: 11.4.0

Represents a JSON array, which contains an ordered list of JSON values, where each value can be a string, number, JSON object, JSON array, true, false, or null.

Object Creation

Note: This is intended for running within a Chilkat.Js embedded JavaScript engine.

var obj = new CkJsonArray();

Properties

DebugLogFilePath

DebugLogFilePath

· string

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

EmitCompact

EmitCompact

· boolean

Introduced in version 9.5.0.64

If true then the Emit method outputs in the most compact form possible (a single-line with no extra whitespace). If false, then emits with whitespace and indentation to make the JSON human-readable.

The default value is true.

EmitCrlf

EmitCrlf

· boolean

Introduced in version 9.5.0.64

If true then the Emit method uses CRLF line-endings when emitting the non-compact (pretty-print) format. If false, then bare-LF's are emitted. (The compact format emits to a single line with no end-of-line characters.) Windows systems traditionally use CRLF line-endings, whereas Linux, Mac OS X, and other systems traditionally use bare-LF line-endings.

The default value is true.

LastErrorHtml

LastErrorHtml

· string, read-only

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

LastErrorText

· string, read-only

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

LastErrorXml

· string, read-only

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

LastMethodSuccess

· boolean

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

Size

Size

· int, read-only

Introduced in version 9.5.0.56

The number of JSON values in the array.

VerboseLogging

VerboseLogging

· boolean

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

Version

· string, read-only

Version of the component/library, such as "10.1.0"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddArrayAt

var success = AddArrayAt(index);

· return: boolean; true for success, false for failure
· index: int

Introduced in version 9.5.0.56

Inserts a new and empty JSON array member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

More Information and Examples

Modify Parts of JSON Document

AddArrayAt2

var success = AddArrayAt2(index, jarr);

· return: boolean; true for success, false for failure
· index: int
· jarr: CkJsonArray

Introduced in version 11.1.0

Inserts a new and empty JSON array member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0). The jarr is an output argument that references the appended JSON array.

Returns true for success, false for failure.

AddBoolAt

var success = AddBoolAt(index, value);

· return: boolean; true for success, false for failure
· index: int
· value: boolean

Introduced in version 9.5.0.56

Inserts a new boolean member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

More Information and Examples

Modify Parts of JSON Document

AddIntAt

var success = AddIntAt(index, value);

· return: boolean; true for success, false for failure
· index: int
· value: int

Introduced in version 9.5.0.56

Inserts a new integer member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

More Information and Examples

Modify Parts of JSON Document

AddNullAt

var success = AddNullAt(index);

· return: boolean; true for success, false for failure
· index: int

Introduced in version 9.5.0.56

Inserts a new null member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

More Information and Examples

Modify Parts of JSON Document

AddNumberAt

var success = AddNumberAt(index, numericStr);

· return: boolean; true for success, false for failure
· index: int
· numericStr: string

Introduced in version 9.5.0.56

Inserts a new numeric member to the position indicated by index. The numericStr is an integer, float, or double already converted to a string in the format desired by the application. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

More Information and Examples

Create more Complex JSON Document Modify Parts of JSON Document

AddObjectAt

var success = AddObjectAt(index);

· return: boolean; true for success, false for failure
· index: int

Introduced in version 9.5.0.56

Inserts a new and empty JSON object member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

More Information and Examples

Create more Complex JSON Document Modify Parts of JSON Document

AddObjectAt2

var success = AddObjectAt2(index, json);

· return: boolean; true for success, false for failure
· index: int
· json: CkJsonObject

Introduced in version 11.1.0

Inserts a new and empty JSON object member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0). The json is an output argument that references the appended JSON object.

Returns true for success, false for failure.

AddObjectCopyAt

var success = AddObjectCopyAt(index, jsonObj);

· return: boolean; true for success, false for failure
· index: int
· jsonObj: CkJsonObject

Introduced in version 9.5.0.82

Inserts a copy of a JSON object to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

More Information and Examples

JSON Array AddObjectCopyAt Example

AddStringAt

var success = AddStringAt(index, value);

· return: boolean; true for success, false for failure
· index: int
· value: string

Introduced in version 9.5.0.56

Inserts a new string at the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

More Information and Examples

Create more Complex JSON Document Modify Parts of JSON Document

AddUIntAt

var success = AddUIntAt(index, value);

· return: boolean; true for success, false for failure
· index: int
· value: unsigned int

Introduced in version 9.5.0.96

Inserts a new unsigned integer member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

AppendArrayItems

var success = AppendArrayItems(jarr);

· return: boolean; true for success, false for failure
· jarr: CkJsonArray

Introduced in version 9.5.0.82

Appends the array items contained in jarr.

Returns true for success, false for failure.

More Information and Examples

AppendArrayItems Example

ArrayAt2

var success = ArrayAt2(index, jarr);

· return: boolean; true for success, false for failure
· index: int
· jarr: CkJsonArray

Introduced in version 11.0.0

Sets jarr to reference the JSON array found at index, where indexing starts at 0.

Returns true for success, false for failure.

BoolAt

var boolVal = BoolAt(index);

· return: boolean
· index: int

Introduced in version 9.5.0.56

Returns the boolean value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

Clear

Clear();

· return: undefined

Introduced in version 9.5.0.76

Deletes all array elements.

DateAt

var success = DateAt(index, dateTime);

· return: boolean; true for success, false for failure
· index: int
· dateTime: CkDateTime

Introduced in version 9.5.0.73

Fills the dateTime with the date/time string located in the Nth array element. Indexing is 0-based (the 1st member is at index 0). Auto-recognizes the following date/time string formats: ISO-8061 Timestamp (such as 2009-11-04T19:55:41Z), RFC822 date/time format (such as Wed, 18 Apr 2018 15:51:55 -0400), or Unix timestamp integers.

Returns true for success, false for failure.

DeleteAt

var success = DeleteAt(index);

· return: boolean; true for success, false for failure
· index: int

Introduced in version 9.5.0.56

Deletes the array element at the given index. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

More Information and Examples

Modify Parts of JSON Document

DtAt

var success = DtAt(index, bLocal, dt);

· return: boolean; true for success, false for failure
· index: int
· bLocal: boolean
· dt: CkDtObj

Introduced in version 9.5.0.73

Fills the dt with the date/time string located in the Nth array element. If bLocal is true, then dt is filled with the local date/time values, otherwise it is filled with the UTC/GMT values. Indexing is 0-based (the 1st member is at index 0). Auto-recognizes the following date/time string formats: ISO-8061 Timestamp (such as 2009-11-04T19:55:41Z), RFC822 date/time format (such as Wed, 18 Apr 2018 15:51:55 -0400), or Unix timestamp integers.

Returns true for success, false for failure.

Emit

var strVal = Emit();

· return: string

Introduced in version 9.5.0.58

Writes the JSON array (rooted at the caller) and returns as a string.

Note: To control the compact/non-compact format, and to control the LF/CRLF line-endings, set the EmitCompact and EmitCrlf properties.

Returns null on failure

EmitSb

var success = EmitSb(sb);

· return: boolean; true for success, false for failure
· sb: CkStringBuilder

Introduced in version 9.5.0.65

Writes the JSON array to the sb.

Note: To control the compact/non-compact format, and to control the LF/CRLF line-endings, set the EmitCompact and EmitCrlf properties.

Returns true for success, false for failure.

More Information and Examples

Emit JSON Array to StringBuilder

FindObject

var intVal = FindObject(name, value, caseSensitive);

· return: int
· name: string
· value: string
· caseSensitive: boolean

Introduced in version 9.5.0.73

Return the index of the first object in the array where value of the field at name matches value. name is an object member name. The value is a value pattern which can use * chars to indicate zero or more of any char. If caseSensitive is false, then the matching is case insenstive, otherwise it is case sensitive. Returns -1 if no matching string was found.

FindString

var intVal = FindString(value, caseSensitive);

· return: int
· value: string
· caseSensitive: boolean

Introduced in version 9.5.0.73

Return the index of the first matching string in the array. The value is a value pattern which can use * chars to indicate zero or more of any char. If caseSensitive is false, then the matching is case insenstive, otherwise it is case sensitive. Returns -1 if no matching string was found.

IntAt

var intVal = IntAt(index);

· return: int
· index: int

Introduced in version 9.5.0.56

Returns the integer value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

IsNullAt

var boolVal = IsNullAt(index);

· return: boolean
· index: int

Introduced in version 9.5.0.56

Returns the true if the Nth array element is null, otherwise returns false. Indexing is 0-based (the 1st member is at index 0).

More Information and Examples

Modify Parts of JSON Document

Load

var success = Load(jsonArray);

· return: boolean; true for success, false for failure
· jsonArray: string

Introduced in version 9.5.0.64

Loads a JSON array from a string. A JSON array must begin with a [ and end with a ].

Note: The Load method causes the JsonArray to detach and become it's own JSON document. It should only be called on new instances of the JsonArray. See the example below.

Returns true for success, false for failure.

More Information and Examples

Understanding JSON Array vs JSON Object

LoadSb

var success = LoadSb(sb);

· return: boolean; true for success, false for failure
· sb: CkStringBuilder

Introduced in version 9.5.0.64

Loads a JSON array from a StringBuilder. A JSON array must begin with a [ and end with a ].

Note: The Load method causes the JsonArray to detach and become it's own JSON document. It should only be called on new instances of the JsonArray. See the example below.

Returns true for success, false for failure.

ObjectAt2

var success = ObjectAt2(index, jsonObj);

· return: boolean; true for success, false for failure
· index: int
· jsonObj: CkJsonObject

Introduced in version 11.0.0

Sets jsonObj to reference the JSON object found at index, where indexing starts at 0.

Returns true for success, false for failure.

SetBoolAt

var success = SetBoolAt(index, value);

· return: boolean; true for success, false for failure
· index: int
· value: boolean

Introduced in version 9.5.0.56

Sets the boolean value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

More Information and Examples

Modify Parts of JSON Document

SetIntAt

var success = SetIntAt(index, value);

· return: boolean; true for success, false for failure
· index: int
· value: int

Introduced in version 9.5.0.56

Sets the integer value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

More Information and Examples

Modify Parts of JSON Document

SetNullAt

var success = SetNullAt(index);

· return: boolean; true for success, false for failure
· index: int

Introduced in version 9.5.0.56

Sets the Nth array element to the value of null. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

SetNumberAt

var success = SetNumberAt(index, value);

· return: boolean; true for success, false for failure
· index: int
· value: string

Introduced in version 9.5.0.56

Sets the numeric value of the Nth array element. The value is an integer, float, or double already converted to a string in the format desired by the application. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

More Information and Examples

Modify Parts of JSON Document

SetStringAt

var success = SetStringAt(index, value);

· return: boolean; true for success, false for failure
· index: int
· value: string

Introduced in version 9.5.0.56

Sets the string value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

More Information and Examples

Modify Parts of JSON Document

SetUIntAt

var success = SetUIntAt(index, value);

· return: boolean; true for success, false for failure
· index: int
· value: unsigned int

Introduced in version 9.5.0.96

Sets the unsigned integer value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

StringAt

var strVal = StringAt(index);

· return: string
· index: int

Introduced in version 9.5.0.56

Returns the string value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

Returns null on failure

Swap

var success = Swap(index1, index2);

· return: boolean; true for success, false for failure
· index1: int
· index2: int

Introduced in version 9.5.0.76

Swaps the items at positions index1 and index2.

Returns true for success, false for failure.

TypeAt

var intVal = TypeAt(index);

· return: int
· index: int

Introduced in version 9.5.0.58

Returns the type of data at the given index. Possible return values are:

string
number
object
array
boolean
null

Returns -1 if no member exists at the given index.

UIntAt

var uintVal = UIntAt(index);

· return: unsigned int
· index: int

Introduced in version 9.5.0.96

Returns the unsigned integer value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).