Interface ICreateSampleSetDomain

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

Properties

containerPath? domainDesign failure? options? success

Properties

Optional containerPath

containerPath?: string

The container path in which to create the domain.

domainDesign

domainDesign: DomainDesign

The domain design to save.

Optional failure

failure?: (() => any)

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

Type declaration

    • (): any

    • Returns any

Optional options

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

Set of extra options used when creating the SampleSet.

Type declaration

  • Optional idCols?: 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.

  • Optional parentCol?: string

    Index of the parent id column.

success

success: ((domain?) => 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.

Type declaration

    • (domain?): any

    • Parameters

      • Optional domain: any

      Returns any

Settings

Member Visibility

Theme

On This Page

containerPathdomainDesignfailureoptionssuccess

Generated using TypeDoc