Interface ICreateSampleSetDomain

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

Properties

containerPath? domainDesign failure? options? success

Properties

OptionalcontainerPath

containerPath?: string

The container path in which to create the domain.

domainDesign

domainDesign: DomainDesign

The domain design to save.

Optionalfailure

failure?: (() => any)

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

Optionaloptions

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

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