new Dimension
Parameters:
Name | Type | Argument | Default | Description |
---|---|---|---|---|
title |
String | The string identifier for this dimension. | ||
field |
String | The field string to obtain dimension child items. | ||
id |
String |
<optional> |
"" | The optional field string to obtain unique identifiers for dimension child items. |
- Source:
- ../../src/teechart-data.js, line 1004
Methods
-
addDimension
-
Parameters:
Name Type Argument Default Description title
String The string identifier for this dimension. field
String The field string to obtain dimension child items. id
String <optional>
"" The optional field string to obtain unique identifiers for dimension child items. - Source:
- ../../src/teechart-data.js, line 1036
Returns:
Creates and returns a new child dimension.- Type
- Tee.Data.Dimension
-
addLink
-
Parameters:
Name Type Description field
String | Array The string field(s) identifier(s) for this origin dimension. dimension
Tee.Data.Dimension The destination dimension. datasetField
String | Array The string field(s) identifier(s) for the destination dimension. - Source:
- ../../src/teechart-data.js, line 1081
Returns:
Creates and returns a new link object that knows how to get from this origin dimension to destination {dimension} parameter.- Type
- object
-
addMetric
-
Parameters:
Name Type Argument Default Description title
String The string identifier for this metric. name
String The field string to obtain metric values from parent dimension items. measure
String <optional>
"sum" The optional measure style for this metric. - Source:
- ../../src/teechart-data.js, line 1064
Returns:
Creates and returns a new metric for this dimension.- Type
- Tee.Data.Metric
-
anySelected
-
- Source:
- ../../src/teechart-data.js, line 1230
Returns:
Returns true when selected filter is not empty.- Type
- boolean
-
datePart
-
Parameters:
Name Type Description date
Date The Date value. - Source:
- ../../src/teechart-data.js, line 1147
Returns:
Returns the currently selected part of {date} parameter.- Type
- Number
-
get
-
Parameters:
Name Type Description id
object The identifier value to search for. - Source:
- ../../src/teechart-data.js, line 1124
Returns:
Search for an item with {id} as identifier and return it.- Type
- object
-
hasParent
-
Parameters:
Name Type Description dimension
Tee.Data.Dimension The dimension to test as parent. - Source:
- ../../src/teechart-data.js, line 1091
Returns:
Returns true when this dimension has {dimension} parameter as parent in the hierarchy.- Type
- boolean
-
inSelected
-
Parameters:
Name Type Description data
object The value to check for. - Source:
- ../../src/teechart-data.js, line 1105
Returns:
Returns true when data is a value of the current selected filter.- Type
- boolean
-
isSelected
-
Parameters:
Name Type Description data
object The value to search. - Source:
- ../../src/teechart-data.js, line 1217
Returns:
Returns true when {data} parameter is in the currently selected list.- Type
- boolean
-
toggleSelected
-
Selects or unselects a given series index point value.
Parameters:
Name Type Description series
Tee.Series The series to toggle its index point format. - Source:
- ../../src/teechart-data.js, line 1254
-
traverse
-
Traverses all items belonging to this dimension and calls the process function for each item.
Parameters:
Name Type Description process
function The function that will get called for each item in the dimension. - Source:
- ../../src/teechart-data.js, line 1277