Interface GetStudyNabGraphURLOptions

Hierarchy

Properties

chartTitle?: string

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

containerPath?: string

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

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

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

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

height?: number

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

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.

scope?: any

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

This will be called upon successfully completing a request.

timeout?: number

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

width?: number

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

Generated using TypeDoc