ecl-logo Documentation

Object[Favorite, Folder]

A folder object that can hold multiple favorite objects.

Organizational Information

    Name

    Name of this Object.
    Format: Single
    Class: String
    Programmatic Pattern: _String
    Pattern Description: A string.

    ID

    ID of this Object.
    Format: Single
    Class: String
    Programmatic Pattern: _String
    Pattern Description: The ID of this object.

    Object

    Object of this Object.
    Format: Single
    Class: Expression
    Programmatic Pattern: Object[Favorite, Folder, _String]
    Pattern Description: The object reference of this object.

    Type

    Type of this Object.
    Format: Single
    Class: Expression
    Programmatic Pattern: Object[Favorite, Folder]
    Pattern Description: Object[Favorite, Folder]

    Notebook

    Notebook this object belongs to.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link
    Pattern Description: An object of that matches ObjectP[Object[LaboratoryNotebook]].

    DisplayName

    Display name of the folder containing favorite objects, this is a required field.
    Format: Single
    Class: String
    Programmatic Pattern: _String

General

    Authors

    The people who selected the object to be marked as favorite. When more than one person marks as favorite, this field will be appended.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    FavoriteFolder

    The folder where the favorite object is stored. Foe bookmark objects, this will always be Null.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    TargetObject

    The target object being saved as a favorite so it can be quickly accessed later.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link
    Relation: Object[] | Model[]

    Team

    The team whose members should be able to see this folder.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    Columns

    The information needed to display objects of each type including their requested fields and field labels.
    Format: Multiple

    [ColumnObjectType]

      Header: ColumnObjectType
      Class: String

    [ColumnFields]

      Header: ColumnFields
      Class: String

    [ColumnLabels]

      Header: ColumnLabels
      Class: String

    FavoriteObjects

    All the favorite objects within this folder that have been saved for later.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link
Last modified on Mon 26 Sep 2022 15:43:44