Class ItemConfiguration

Constructors

Properties

configuration: ICategoryConfigMap = {}
json: IJSONTools
logger: ILoggerTools
settings: XRProjectInfo
settingsJSON: ISettingMapJSON = {}
settingsString: ISettingMapString = {}
timewarpDate: string
userGroups: XRGroupPermissionType[] = []
userList: XRUserPermissionType[] = []
users: XRUserPermissionType[] = []

Methods

  • getValidUserOptions returns an array of option values that describe the users and groups available as values for a user field in the database (fields of type FieldDescriptions.Field_user).

    Parameters

    • showUsers: boolean

      pass true to include users

    • showGroups: boolean

      pass true to include groups

    • Optional preSelectedUsers: XRUserPermissionType[]

      if present, the list of users will be limited to this subset and the full user list will not be consulted to construct the return value.

    • Optional possiblyDeletedUserGroupNames: string

      if present, a comma-separated list of user and group names. The returned options will include these values, and mark deleted user and groups as disabled.

    Returns IDropdownOption[]

    An array of IDropdownOptions configured according to the input parameters and the users and groups of the current project.

Generated using TypeDoc