Interface GetStudyNabGraphURLOptions

interface GetStudyNabGraphURLOptions {
    chartTitle?: string;
    containerPath?: string;
    failure?: RequestFailure<any>;
    fitType?: "FIVE_PARAMETER" | "FOUR_PARAMETER" | "POLYNOMIAL";
    height?: number;
    objectIds: (string | number)[];
    scope?: any;
    success?: RequestSuccess<GetStudyNabGraphURLResponse>;
    timeout?: number;
    width?: number;
}

Hierarchy (view full)

Properties

chartTitle? containerPath? failure? fitType? height? objectIds scope? success? timeout? width?

Properties

OptionalchartTitle

chartTitle?: string

The desired title for the chart. Defaults to no title.

OptionalcontainerPath

containerPath?: string

The path to the study container containing the NAb summary data, if different from 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.

OptionalfitType

fitType?: "FIVE_PARAMETER" | "FOUR_PARAMETER" | "POLYNOMIAL"

Allowable values are FIVE_PARAMETER, FOUR_PARAMETER, and POLYNOMIAL. Defaults to FIVE_PARAMETER.

Optionalheight

height?: number

Desired height of the graph image in pixels. Defaults to 300.

objectIds

objectIds: (string | number)[]

The object Ids for the NAb data rows that have been copied to the study. This method will ignore requests to graph any object IDs that the current user does not have permission to view.

Optionalscope

scope?: any

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

Optionalsuccess

success?: RequestSuccess<GetStudyNabGraphURLResponse>

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).

Optionalwidth

width?: number

Desired width of the graph image in pixels. Defaults to 425.

Settings

Member Visibility

On This Page

Properties