Type Alias NxGroupDef

Defines the properties of an object group.

Stability: experimental

type NxGroupDef = {
    qClass?: NxGroupMemberClass;
    qGroupType?: string;
    qIncludeOrphanGroups?: boolean;
    qLabel?: string;
    qMemberIds?: NxGroupObjectId[];
    qObjectType?: string;
}
Index

Properties

qClass? qGroupType? qIncludeOrphanGroups? qLabel? qMemberIds? qObjectType?

Properties

qClass?: NxGroupMemberClass

Specifies the class of the group's object members.

One of:

  • bookmark or MEMBER_BOOKMARK
  • object or MEMBER_OBJECT
qGroupType?: string

Specifies the type of the group's subgroup members.

qIncludeOrphanGroups?: boolean

Include all groups of the relevant type, by adding those groups last that are not explicitly included in the hierarchy (orphans)

qLabel?: string

The group's label. Will be evaluated as an expression if it starts with '='.

qMemberIds?: NxGroupObjectId[]

The objects and sub-groups that are members of the group.

qObjectType?: string

Specifies the type of the group's object members.

Settings

Member Visibility

On This Page

Properties