@labkey/api
    Preparing search index...

    Interface ICreateSampleSetDomain

    interface ICreateSampleSetDomain {
        containerPath?: string;
        domainDesign: DomainDesign;
        failure?: () => any;
        options?: { idCols?: string[]; parentCol?: string };
        success: (domain?: any) => any;
    }
    Index

    Properties

    containerPath? domainDesign failure? options? success

    Properties

    containerPath?: string

    The container path in which to create the domain.

    domainDesign: DomainDesign

    The domain design to save.

    failure?: () => any

    Function called if execution of the "getDomainDetails" function fails.

    options?: { idCols?: string[]; parentCol?: string }

    Set of extra options used when creating the SampleSet.

    Type declaration

    • OptionalidCols?: string[]

      Array of indexes into the domain design fields. If the domain design contains a 'Name' field, no idCols are allowed. Either a 'Name' field must be present or at least one idCol must be supplied.

    • OptionalparentCol?: string

      Index of the parent id column.

    success: (domain?: any) => any

    Function called if the "getDomainDetails" function executes successfully. Will be called with the domain object as returned by getDomainDetails which describes the fields of a domain.

    Settings

    Member Visibility

    On This Page

    Properties