Data3d
data3d() function to create data3d objects.A three dimensional array of primarykey-datakey-value data structure. The data3d object has the following properties:
Properties
- Name
data- Type
- array<data2d>
- Description
An array of
data2dobjects.
- Name
primaryKeys- Type
- array<string>
- Description
An array of primary key identifiers. Optional. The default is na.
- Name
dataKeys- Type
- array<string>
- Description
An array of data key identifiers. Optional. The default is na.
- Name
dataTypes- Type
- array<string>
- Description
An array of data types for each data keys. Optional. The default is na.
- Name
dataType- Type
- string
- Description
The data type representing all data keys. Possible values are string, float, int, bool, color, timestamp, or mix. Optional. The default is na.
- Name
size- Type
- int
- Description
Total size of the data3d object. Optional. The default is na.
- Name
sorted- Type
- bool
- Description
A boolean flag to determine if the data3d object is sorted or not. Optional. The default is na.
- Name
sortByKey- Type
- string
- Description
The data key used for sorting the data3d object. Optional. The default is na.
- Name
asc- Type
- bool
- Description
A boolean flag to determine if sorting is in ascending or descending order. Use 'true' for ascending and 'false' for descending. Optional. The default is true.
- Name
change- Type
- bool
- Description
A boolean flag to determine if sorting uses change percent values. Use 'true' for sorting using change percent value. Optional. The default is false.
- Name
format- Type
- string
- Description
A default string format for values. Optional. The default is na.
- Name
formatTime- Type
- string
- Description
A default time format for timestamp values. Optional. The default is 'yyyy-MM-dd hh:mm:ss a z'.
- Name
index- Type
- array<int>
- Description
An array of integer values representing primary key index. If the object is sorted, the index will be in sorted order. Optional. The default is na.
- Name
timezone- Type
- string
- Description
A default timezone value for the data3d object. Optional. The default is 'syminfo.timezone'.
data3d()
The data3d() function is the recommended way to create data3d objects. This function ensures that all keys are unique and performs essential internal
functions to create the data3d object efficiently.
- Name
pkvs- Type
- array<pkv>
- Description
An array of pkv objects.
- Name
sort- Type
- bool
- Description
Use true for sorting, false otherwise. Optional. The default is false.
- Name
sortByKey- Type
- string
- Description
The data key used for sorting. Optional. The default is na.
- Name
asc- Type
- bool
- Description
Use true for sort order.ascending, false for sort order.descending. Optional. The default is true.
- Name
change- Type
- bool
- Description
Sorts using change percent if true. Optional. The default is false.
- Name
format- Type
- string
- Description
A default format. Optional. The default is na.
- Name
timezone- Type
- string
- Description
A default timezone. Optional. The default is 'syminfo.timezone'.
- Name
returns- Type
- data3d
- Description
A data3d object.