Interface GetStudyNabRunsOptions

interface GetStudyNabRunsOptions {
    calculateNeut?: boolean;
    containerPath?: string;
    failure?: RequestFailure<any>;
    includeFitParameters?: boolean;
    includeStats?: boolean;
    includeWells?: boolean;
    objectIds: (string | number)[];
    scope?: any;
    success?: RequestSuccess<any>;
    timeout?: number;
}

Hierarchy (view full)

Properties

calculateNeut? containerPath? failure? includeFitParameters? includeStats? includeWells? objectIds scope? success? timeout?

Properties

OptionalcalculateNeut

calculateNeut?: boolean

Whether neutralization should be calculated on the server.

OptionalcontainerPath

containerPath?: string

The path to the study container containing the NAb summary, if different than the current container. If not supplied, the current container's path will be used.

Optionalfailure

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

OptionalincludeFitParameters

includeFitParameters?: boolean

Whether the parameters used in the neutralization curve fitting calculation should be included in the response.

OptionalincludeStats

includeStats?: boolean

Whether statistics (standard deviation, max, min, etc.) should be returned with calculations and well data.

OptionalincludeWells

includeWells?: boolean

Whether well-level data should be included in the response.

objectIds

objectIds: (string | number)[]

The object Ids for the NAb data rows that have been copied to the study.

Optionalscope

scope?: any

A scoping object for the success and failure callback functions (default to this).

Optionalsuccess

success?: RequestSuccess<any>

This will be called upon successfully completing a request.

Optionaltimeout

timeout?: number

The maximum number of milliseconds to allow for this operation before generating a timeout error (defaults to 30000).

Settings

Member Visibility

On This Page

Properties