Interface SelectRowsOptions

interface SelectRowsOptions {
    columns?: string | string[];
    containerFilter?: ContainerFilter;
    containerPath?: string;
    dataRegionName?: string;
    failure?: RequestFailure<any>;
    filterArray?: IFilter[];
    ignoreFilter?: boolean;
    includeDetailsColumn?: boolean;
    includeMetadata?: boolean;
    includeStyle?: boolean;
    includeTotalCount?: boolean;
    includeUpdateColumn?: boolean;
    maxRows?: number;
    method?: "GET" | "POST";
    offset?: number;
    parameters?: any;
    queryName: string;
    requiredVersion?: string | number;
    schemaName: string;
    scope?: any;
    selectionKey?: string;
    showRows?: ShowRows;
    sort?: string;
    stripHiddenColumns?: boolean;
    success?: RequestSuccess<any>;
    timeout?: number;
    viewName?: string;
}

Hierarchy (view full)

Properties

columns?: string | string[]

An Array of columns or a comma-delimited list of column names you wish to select from the specified query. By default, selectRows will return the set of columns defined in the default value for this query, as defined via the Customize View user interface on the server. You can override this by specifying a list of column names in this parameter, separated by commas. The names can also include references to related tables (e.g., 'RelatedPeptide/Peptide' where 'RelatedPeptide is the name of a foreign key column in the base query, and 'Peptide' is the name of a column in the related table).

containerFilter?: ContainerFilter

One of the values of ContainerFilter that sets the scope of this query. Defaults to ContainerFilter.current, and is interpreted relative to config.containerPath.

containerPath?: string

The path to the container in which the schema and query are defined, if different than the current container. If not supplied, the current container's path will be used.

dataRegionName?: string

Prefix for query parameters (e.g. filters, sorts, etc) in this request. Defaults to "query".

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

filterArray?: IFilter[]

Array of objects created by Filter.create.

ignoreFilter?: boolean

If true, the command will ignore any filter that may be part of the chosen view.

includeDetailsColumn?: boolean

Include the Details link column in the set of columns (defaults to false). If included, the column will have the name "Details". The underlying table/query must support details links or the column will be omitted in the response.

includeMetadata?: boolean

Include metadata for the selected columns. Defaults to true.

includeStyle?: boolean
includeTotalCount?: boolean

Include the total number of rows available (defaults to true). If false totalCount will equal number of rows returned (equal to maxRows unless maxRows == 0).

includeUpdateColumn?: boolean

Include the Update (or edit) link column in the set of columns (defaults to false). If included, the column will have the name "Update". The underlying table/query must support update links or the column will be omitted in the response.

maxRows?: number

The maximum number of rows to return from the server (defaults to 100000). If you want to return all possible rows, set this config property to -1.

method?: "GET" | "POST"

Specify the HTTP method to use when making the request. Defaults to GET.

offset?: number

The index of the first row to return from the server (defaults to 0). Use this along with the maxRows config property to request pages of data.

parameters?: any
queryName: string

Name of a query table associated with the chosen schema. See also: How To Find schemaName, queryName & viewName.

requiredVersion?: string | number
schemaName: string

Name of a schema defined within the targeted container. See also: How To Find schemaName, queryName & viewName.

scope?: any

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

selectionKey?: string

Unique string used by selection APIs as a key when storing or retrieving the selected items for a grid. Not used unless "showRows" is 'selected' or 'unselected'.

showRows?: ShowRows
sort?: string

String description of the sort. It includes the column names listed in the URL of a sorted data region (with an optional minus prefix to indicate descending order). In the case of a multi-column sort, up to three column names can be included, separated by commas.

stripHiddenColumns?: boolean

If true, removes columns marked as "hidden" in response as well as data associated with that column. This is done in client-side post-processing.

success?: RequestSuccess<any>

This will be called upon successfully completing a request.

timeout?: number

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

viewName?: string

The name of a custom view saved on the server for the specified query.