Comparison
One of the benefits of storing alternate values is the built-in functionality of comparison methods. These methods enable easy comparison and calculation of differences between main and alternate values.
et()
Get 'equal to' comparison for the specified key(s). (main == alt)
- Name
this- Type
- object
- Description
A data2d or a data3d object.
- Name
key- Type
- string
- Description
A key identifier. This parameter is only available with data2d object; not available for data3d.
- Name
primaryKey- Type
- string
- Description
A data3d primary key. This parameter is only available with data3d object; not available for data2d.
- Name
dataKey- Type
- string
- Description
A data3d data key. This parameter is only available with data3d object; not available for data2d.
- Name
returns- Type
- bool
- Description
A boolean value.
et()
Get 'equal to' comparison of all the keys. (main == alt)
- Name
this- Type
- data2d
- Description
A data2d object.
- Name
returns- Type
- array<bool>
- Description
A boolean array.
pkEt()
Get all 'equal to' comparison of a primary key. (main == alt)
- Name
this- Type
- data3d
- Description
A data3d object.
- Name
primaryKey- Type
- string
- Description
A data3d primary key.
- Name
returns- Type
- array<bool>
- Description
A boolean array.
dkEt()
Get all 'equal to' comparison of a data key. (main == alt)
- Name
this- Type
- data3d
- Description
A data3d object.
- Name
dataKey- Type
- string
- Description
A data3d data key.
- Name
returns- Type
- array<bool>
- Description
A boolean array.
gt()
Get 'greater than' comparison for the specified key(s). (main > alt)
- Name
this- Type
- object
- Description
A data2d or a data3d object.
- Name
key- Type
- string
- Description
A key identifier. This parameter is only available with data2d object; not available for data3d.
- Name
primaryKey- Type
- string
- Description
A data3d primary key. This parameter is only available with data3d object; not available for data2d.
- Name
dataKey- Type
- string
- Description
A data3d data key. This parameter is only available with data3d object; not available for data2d.
- Name
returns- Type
- bool
- Description
A boolean value.
gt()
Get 'greater than' comparison of all the keys. (main > alt)
- Name
this- Type
- data2d
- Description
A data2d object.
- Name
returns- Type
- array<bool>
- Description
A boolean array.
pkGt()
Get all 'greater than' comparison of a primary key. (main > alt)
- Name
this- Type
- data3d
- Description
A data3d object.
- Name
primaryKey- Type
- string
- Description
A data3d primary key.
- Name
returns- Type
- array<bool>
- Description
A boolean array.
dkGt()
Get all 'greater than' comparison of a data key. (main > alt)
- Name
this- Type
- data3d
- Description
A data3d object.
- Name
dataKey- Type
- string
- Description
A data3d data key.
- Name
returns- Type
- array<bool>
- Description
A boolean array.
gte()
Get 'greater than or equal to' comparison for the specified key(s). (main ≥ alt)
- Name
this- Type
- object
- Description
A data2d or a data3d object.
- Name
key- Type
- string
- Description
A key identifier. This parameter is only available with data2d object; not available for data3d.
- Name
primaryKey- Type
- string
- Description
A data3d primary key. This parameter is only available with data3d object; not available for data2d.
- Name
dataKey- Type
- string
- Description
A data3d data key. This parameter is only available with data3d object; not available for data2d.
- Name
returns- Type
- bool
- Description
A boolean value.
gte()
Get 'greater than or equal to' comparison of all the keys. (main ≥ alt)
- Name
this- Type
- data2d
- Description
A data2d object.
- Name
returns- Type
- array<bool>
- Description
A boolean array.
pkGte()
Get all 'greater than or equal to' comparison of a primary key. (main ≥ alt)
- Name
this- Type
- data3d
- Description
A data3d object.
- Name
primaryKey- Type
- string
- Description
A data3d primary key.
- Name
returns- Type
- array<bool>
- Description
A boolean array.
dkGte()
Get all 'greater than or equal to' comparison of a data key. (main ≥ alt)
- Name
this- Type
- data3d
- Description
A data3d object.
- Name
dataKey- Type
- string
- Description
A data3d data key.
- Name
returns- Type
- array<bool>
- Description
A boolean array.
lt()
Get 'less than' comparison for the specified key(s). (main < alt)
- Name
this- Type
- object
- Description
A data2d or a data3d object.
- Name
key- Type
- string
- Description
A key identifier. This parameter is only available with data2d object; not available for data3d.
- Name
primaryKey- Type
- string
- Description
A data3d primary key. This parameter is only available with data3d object; not available for data2d.
- Name
dataKey- Type
- string
- Description
A data3d data key. This parameter is only available with data3d object; not available for data2d.
- Name
returns- Type
- bool
- Description
A boolean value.
lt()
Get 'less than' comparison of all the keys. (main < alt)
- Name
this- Type
- data2d
- Description
A data2d object.
- Name
returns- Type
- array<bool>
- Description
A boolean array.
pkLt()
Get all 'less than' comparison of a primary key. (main < alt)
- Name
this- Type
- data3d
- Description
A data3d object.
- Name
primaryKey- Type
- string
- Description
A data3d primary key.
- Name
returns- Type
- array<bool>
- Description
A boolean array.
dkLt()
Get all 'less than' comparison of a data key. (main < alt)
- Name
this- Type
- data3d
- Description
A data3d object.
- Name
dataKey- Type
- string
- Description
A data3d data key.
- Name
returns- Type
- array<bool>
- Description
A boolean array.
lte()
Get 'less than or equal to' comparison for the specified key(s). (main ≤ alt)
- Name
this- Type
- object
- Description
A data2d or a data3d object.
- Name
key- Type
- string
- Description
A key identifier. This parameter is only available with data2d object; not available for data3d.
- Name
primaryKey- Type
- string
- Description
A data3d primary key. This parameter is only available with data3d object; not available for data2d.
- Name
dataKey- Type
- string
- Description
A data3d data key. This parameter is only available with data3d object; not available for data2d.
- Name
returns- Type
- bool
- Description
A boolean value.
lte()
Get 'less than or equal to' comparison of all the keys. (main ≤ alt)
- Name
this- Type
- data2d
- Description
A data2d object.
- Name
returns- Type
- array<bool>
- Description
A boolean array.
pkLte()
Get all 'less than or equal to' comparison of a primary key. (main ≤ alt)
- Name
this- Type
- data3d
- Description
A data3d object.
- Name
primaryKey- Type
- string
- Description
A data3d primary key.
- Name
returns- Type
- array<bool>
- Description
A boolean array.
dkLte()
Get all 'less than or equal to' comparison of a data key. (main ≤ alt)
- Name
this- Type
- data3d
- Description
A data3d object.
- Name
dataKey- Type
- string
- Description
A data3d data key.
- Name
returns- Type
- array<bool>
- Description
A boolean array.
change()
Get change or change percent for the specified key(s). (main - alt)
- Name
this- Type
- object
- Description
A data2d or a data3d object.
- Name
key- Type
- string
- Description
A key identifier. This parameter is only available with data2d object; not available for data3d.
- Name
primaryKey- Type
- string
- Description
A data3d primary key. This parameter is only available with data3d object; not available for data2d.
- Name
dataKey- Type
- string
- Description
A data3d data key. This parameter is only available with data3d object; not available for data2d.
- Name
returns- Type
- float
- Description
A float value.
change()
Get change or change percent of all the keys. (main - alt)
- Name
this- Type
- data2d
- Description
A data2d object.
- Name
returns- Type
- array<float>
- Description
A float array.
pkChange()
Get all change or change percent of a primary key. (main - alt)
- Name
this- Type
- data3d
- Description
A data3d object.
- Name
primaryKey- Type
- string
- Description
A data3d primary key.
- Name
returns- Type
- array<float>
- Description
A float array.
dkChange()
Get all change or change percent of a data key. (main - alt)
- Name
this- Type
- data3d
- Description
A data3d object.
- Name
dataKey- Type
- string
- Description
A data3d data key.
- Name
returns- Type
- array<float>
- Description
A float array.
changeF()
Get formatted change or change percent for the specified key(s). (main - alt)
- Name
this- Type
- object
- Description
A data2d or a data3d object.
- Name
key- Type
- string
- Description
A key identifier. This parameter is only available with data2d object; not available for data3d.
- Name
primaryKey- Type
- string
- Description
A data3d primary key. This parameter is only available with data3d object; not available for data2d.
- Name
dataKey- Type
- string
- Description
A data3d data key. This parameter is only available with data3d object; not available for data2d.
- Name
percent- Type
- bool
- Description
Set to true to get change percent values instead. Optional. The default is false.
- Name
format- Type
- na
- Description
A custom format. Uses a default format, if nothing is provided. Optional. The default is na.
- Name
returns- Type
- string
- Description
A string value.
changeF()
Get formatted change or change percent of all the keys. (main - alt)
- Name
this- Type
- data2d
- Description
A data2d object.
- Name
percent- Type
- bool
- Description
Set to true to get change percent values instead. Optional. The default is false.
- Name
format- Type
- na
- Description
A custom format. Uses a default format, if nothing is provided. Optional. The default is na.
- Name
returns- Type
- array<string>
- Description
A string array.
pkChangeF()
Get all formatted change or change percent of a primary key. (main - alt)
- Name
this- Type
- data3d
- Description
A data3d object.
- Name
primaryKey- Type
- string
- Description
A data3d primary key.
- Name
percent- Type
- bool
- Description
Set to true to get change percent values instead. Optional. The default is false.
- Name
format- Type
- na
- Description
A custom format. Uses a default format, if nothing is provided. Optional. The default is na.
- Name
returns- Type
- array<string>
- Description
A string array.
dkChangeF()
Get all formatted change or change percent of a data key. (main - alt)
- Name
this- Type
- data3d
- Description
A data3d object.
- Name
dataKey- Type
- string
- Description
A data3d data key.
- Name
percent- Type
- bool
- Description
Set to true to get change percent values instead. Optional. The default is false.
- Name
format- Type
- na
- Description
A custom format. Uses a default format, if nothing is provided. Optional. The default is na.
- Name
returns- Type
- array<string>
- Description
A string array.
timestampChange()
Get segmented time difference for the specified key(s). (main - alt)
- Name
this- Type
- object
- Description
A data2d or a data3d object.
- Name
key- Type
- string
- Description
A key identifier. This parameter is only available with data2d object; not available for data3d.
- Name
primaryKey- Type
- string
- Description
A data3d primary key. This parameter is only available with data3d object; not available for data2d.
- Name
dataKey- Type
- string
- Description
A data3d data key. This parameter is only available with data3d object; not available for data2d.
- Name
years- Type
- bool
- Description
Switch to turn on/off the years segment. Off by default. Optional. The default is false.
- Name
months- Type
- bool
- Description
Switch to turn on/off the months segment. Off by default. Optional. The default is false.
- Name
weeks- Type
- bool
- Description
Switch to turn on/off the weeks segment. Off by default. Optional. The default is false.
- Name
days- Type
- bool
- Description
Switch to turn on/off the days segment. On by default. Optional. The default is true.
- Name
hours- Type
- bool
- Description
Switch to turn on/off the hours segment. On by default. Optional. The default is true.
- Name
minutes- Type
- bool
- Description
Switch to turn on/off the minutes segment. On by default. Optional. The default is true.
- Name
seconds- Type
- bool
- Description
Switch to turn on/off the seconds segment. On by default. Optional. The default is true.
- Name
returns- Type
- string
- Description
A string value.
timestampChange()
Get segmented time difference of all the keys. (main - alt)
- Name
this- Type
- data2d
- Description
A data2d object.
- Name
years- Type
- bool
- Description
Switch to turn on/off the years segment. Off by default. Optional. The default is false.
- Name
months- Type
- bool
- Description
Switch to turn on/off the months segment. Off by default. Optional. The default is false.
- Name
weeks- Type
- bool
- Description
Switch to turn on/off the weeks segment. Off by default. Optional. The default is false.
- Name
days- Type
- bool
- Description
Switch to turn on/off the days segment. On by default. Optional. The default is true.
- Name
hours- Type
- bool
- Description
Switch to turn on/off the hours segment. On by default. Optional. The default is true.
- Name
minutes- Type
- bool
- Description
Switch to turn on/off the minutes segment. On by default. Optional. The default is true.
- Name
seconds- Type
- bool
- Description
Switch to turn on/off the seconds segment. On by default. Optional. The default is true.
- Name
returns- Type
- array<string>
- Description
A string array.
pkTimestampChange()
Get all segmented time difference of a primary key. (main - alt)
- Name
this- Type
- data3d
- Description
A data3d object.
- Name
primaryKey- Type
- string
- Description
A data3d primary key.
- Name
years- Type
- bool
- Description
Switch to turn on/off the years segment. Off by default. Optional. The default is false.
- Name
months- Type
- bool
- Description
Switch to turn on/off the months segment. Off by default. Optional. The default is false.
- Name
weeks- Type
- bool
- Description
Switch to turn on/off the weeks segment. Off by default. Optional. The default is false.
- Name
days- Type
- bool
- Description
Switch to turn on/off the days segment. On by default. Optional. The default is true.
- Name
hours- Type
- bool
- Description
Switch to turn on/off the hours segment. On by default. Optional. The default is true.
- Name
minutes- Type
- bool
- Description
Switch to turn on/off the minutes segment. On by default. Optional. The default is true.
- Name
seconds- Type
- bool
- Description
Switch to turn on/off the seconds segment. On by default. Optional. The default is true.
- Name
returns- Type
- array<string>
- Description
A string array.
dkTimestampChange()
Get all segmented time difference of a data key. (main - alt)
- Name
this- Type
- data3d
- Description
A data3d object.
- Name
dataKey- Type
- string
- Description
A data3d data key.
- Name
years- Type
- bool
- Description
Switch to turn on/off the years segment. Off by default. Optional. The default is false.
- Name
months- Type
- bool
- Description
Switch to turn on/off the months segment. Off by default. Optional. The default is false.
- Name
weeks- Type
- bool
- Description
Switch to turn on/off the weeks segment. Off by default. Optional. The default is false.
- Name
days- Type
- bool
- Description
Switch to turn on/off the days segment. On by default. Optional. The default is true.
- Name
hours- Type
- bool
- Description
Switch to turn on/off the hours segment. On by default. Optional. The default is true.
- Name
minutes- Type
- bool
- Description
Switch to turn on/off the minutes segment. On by default. Optional. The default is true.
- Name
seconds- Type
- bool
- Description
Switch to turn on/off the seconds segment. On by default. Optional. The default is true.
- Name
returns- Type
- array<string>
- Description
A string array.