Members
descendents :Array.<Item>
- Description:
All descendents of the current group Item (as returned by 'getAllMembers()')
- Source:
All descendents of the current group Item (as returned by 'getAllMembers()')
Type:
- Array.<Item>
descendentsAvg :number
- Description:
Average value of all descendents of the current group Item (as returned by 'getAllMembers()') Filters for items of type Number, Dimmer & Rollershutter in calculation and not
isUninitialized.
- Source:
Average value of all descendents of the current group Item (as returned by 'getAllMembers()')
Filters for items of type Number, Dimmer & Rollershutter in calculation and not isUninitialized.
Type:
- number
descendentsLabelsString :string
- Description:
Labels of all descendents of the current group item (as returned by 'getAllMembers()'). Must be a group item.
- Source:
Labels of all descendents of the current group item (as returned by 'getAllMembers()'). Must be a group item.
Type:
- string
descendentsMax :Item
- Description:
Maximum state item of all descendents of the current group Item (as returned by 'getAllMembers()') Filters for items not
isUninitialized.
- Source:
Maximum state item of all descendents of the current group Item (as returned by 'getAllMembers()')
Filters for items not isUninitialized.
Type:
- Item
descendentsMin :Item
- Description:
Minimum state item of all descendents of the current group Item (as returned by 'getAllMembers()') Filters for items not
isUninitialized.
- Source:
Minimum state item of all descendents of the current group Item (as returned by 'getAllMembers()')
Filters for items not isUninitialized.
Type:
- Item
descendentsNames :Array.<string>
- Description:
Names of all descendents of the current group item (as returned by 'getAllMembers()'). Must be a group item.
- Source:
Names of all descendents of the current group item (as returned by 'getAllMembers()'). Must be a group item.
Type:
- Array.<string>
descendentsSum :number
- Description:
Summarized value of all descendents of the current group Item (as returned by 'getAllMembers()') Filters for items of type Number, Dimmer & Rollershutter in calculation and not
isUninitialized.
- Source:
Summarized value of all descendents of the current group Item (as returned by 'getAllMembers()')
Filters for items of type Number, Dimmer & Rollershutter in calculation and not isUninitialized.
Type:
- number
members :Array.<Item>
- Description:
Members / children / direct descendents of the current group Item (as returned by 'getMembers()')
- Source:
Members / children / direct descendents of the current group Item (as returned by 'getMembers()')
Type:
- Array.<Item>
membersAvg :number
- Description:
Average value of members / children / direct descendents of the current group Item (as returned by 'getMembers()') Filters for items of type Number, Dimmer & Rollershutter in calculation and not
isUninitialized.
- Source:
Average value of members / children / direct descendents of the current group Item (as returned by 'getMembers()')
Filters for items of type Number, Dimmer & Rollershutter in calculation and not isUninitialized.
Type:
- number
membersLabelsString :string
- Description:
Labels of members / children / direct descendents of the current group Item (as returned by 'getMembers()') as a concatenated string
- Source:
Labels of members / children / direct descendents of the current group Item (as returned by 'getMembers()') as a concatenated string
Type:
- string
membersMax :Item
- Description:
Maximum state item of members / children / direct descendents of the current group Item (as returned by 'getMembers()') Filters for items not
isUninitialized.
- Source:
Maximum state item of members / children / direct descendents of the current group Item (as returned by 'getMembers()')
Filters for items not isUninitialized.
Type:
- Item
membersMin :Item
- Description:
Minimum state item of members / children / direct descendents of the current group Item (as returned by 'getMembers()') Filters for items not
isUninitialized.
- Source:
Minimum state item of members / children / direct descendents of the current group Item (as returned by 'getMembers()')
Filters for items not isUninitialized.
Type:
- Item
membersNames :Array.<string>
- Description:
Names of members / children / direct descendents of the current group Item (as returned by 'getMembers()')
- Source:
Names of members / children / direct descendents of the current group Item (as returned by 'getMembers()')
Type:
- Array.<string>
membersSum :number
- Description:
Summarized value of members / children / direct descendents of the current group Item (as returned by 'getMembers()') Filters for items of type Number, Dimmer & Rollershutter in calculation and not
isUninitialized.
- Source:
Summarized value of members / children / direct descendents of the current group Item (as returned by 'getMembers()')
Filters for items of type Number, Dimmer & Rollershutter in calculation and not isUninitialized.
Type:
- number
Methods
descendentsCount(compareFunc) → {number}
- Description:
Count the number of all descendents of the current group Item (as returned by 'getAllMembers()') matching a comparison
- Source:
Example
itemutils.getGroup('group').descendentsCount(item => item.state === 'ON');Parameters:
| Name | Type | Description |
|---|---|---|
compareFunc |
function | comparison function |
Returns:
number of matches
- Type
- number
membersCount(compareFunc) → {number}
- Description:
Count the number of members / children / direct descendents of the current group Item (as returned by 'getMembers()') matching a comparison
- Source:
Example
itemutils.getGroup('group').membersCount(item => item.state === 'ON');Parameters:
| Name | Type | Description |
|---|---|---|
compareFunc |
function | comparison function |
Returns:
number of matches
- Type
- number