Interface ISaveOptions

interface ISaveOptions {
    description?: string;
    failure?: RequestFailure<any>;
    iconType?: IconType;
    name: string;
    queryName?: string;
    replace?: boolean;
    schemaName?: string;
    scope?: any;
    shared?: boolean;
    success?: RequestSuccess<SaveResponse>;
    svg?: string;
    thumbnailType?: IconType;
    type: string;
    visualizationConfig: any;
}

Hierarchy (view full)

Properties

description? failure? iconType? name queryName? replace? schemaName? scope? shared? success? svg? thumbnailType? type visualizationConfig

Properties

Optionaldescription

description?: string

A description of the saved report.

Optionalfailure

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

OptionaliconType

iconType?: IconType

Indicates whether a icon should be auto-generated ('AUTO'), no icon should be saved ('NONE'), or the existing custom icon should be kept ('CUSTOM').

name

name: string

The name this visualization should be saved under.

OptionalqueryName

queryName?: string

Optional, but required if schemaName property is provided. Allows the visualization to be scoped to a particular query. If scoped, this visualization will appear in the 'views' menu for that query.

Optionalreplace

replace?: boolean

Whether this 'save' call should replace an existing report with the same name. If false, the call to 'save' will fail if another report with the same name exists.

OptionalschemaName

schemaName?: string

Optional, but required if queryName property is provided. Allows the visualization to be scoped to a particular query. If scoped, this visualization will appear in the 'views' menu for that query.

Optionalscope

scope?: any

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

Optionalshared

shared?: boolean

Indicates whether this report is viewable by all users with read permissions to the visualization's folder. If false, only the creating user can see the visualization. Defaults to true.

Optionalsuccess

success?: RequestSuccess<SaveResponse>

This will be called upon successfully completing a request.

Optionalsvg

svg?: string

SVG to be used to generate a thumbnail.

OptionalthumbnailType

thumbnailType?: IconType

Indicates whether a thumbnail should be auto-generated ('AUTO'), no thumbnail should be saved ('NONE'), or the existing custom thumbnail should be kept ('CUSTOM').

type

type: string

The type of visualization being saved.

visualizationConfig

visualizationConfig: any

An arbitrarily complex JavaScript object that contains all information required to recreate the report.

Settings

Member Visibility

On This Page

Properties