IReportWizardState Interface

If implemented, provides functionality for the Report Wizard‘s global state.

Declaration

export interface IReportWizardState extends IDataSourceWizardState

Remarks

The Report Wizard’s global state implements the IReportWizardState interface and stores all the settings required to create a data source.

When the wizard runs, the initialize method initializes the global state with the predefined settings. The wizard’s onFinish method generates a data source based on the resulting global state.

Each wizard page uses a specific subset of the global state (a page’s local state). The page updates its local state based on a user’s input, and then, commits this state to the global state.

See the following topics for more information:

Inheritance

IDataSourceWizardState
IReportWizardState

Properties

colorScheme Property

Specifies the color scheme’s state.

Declaration

colorScheme: IColorSchemeState

Property Value

Type Description
IColorSchemeState

The color scheme’s state.

dataMember Property

Specifies the data member.

Declaration

dataMember?: string

Property Value

Type Description
string

The data member.

dataSource Property

Specifies an existing data source.

Declaration

dataSource?: string

Property Value

Type Description
string

The data source.

ignoreNullValuesForSummary Property

Specifies whether to ignore NULL values when calculate summary functions.

Declaration

ignoreNullValuesForSummary?: boolean

Property Value

Type Description
boolean

true, to ignore NULL values; otherwise, false.

labelDetails Property

Specifies the label’s settings.

Declaration

labelDetails?: ILabelDetails

Property Value

Type Description
ILabelDetails

The label’s settings.

masterDetailGroups Property

Specifies the collection of group settings.

Declaration

masterDetailGroups?: any[]

Property Value

Type Description
any[]

The collection of group settings.

masterDetailInfoCollection Property

Specifies the collection of master-detail relationships.

Declaration

masterDetailInfoCollection?: IMasterDetailQueryInfo[]

Property Value

Type Description
IMasterDetailQueryInfo[]

The collection of master-detail relationships.

masterDetailSummariesInfo Property

Specifies the collection of summary settings.

Declaration

masterDetailSummariesInfo?: {
    [key: string]: {
        column: IDataMemberInfo;
        summaryFunctions: number[];
    }[];
}

Property Value

Type Description
[key: string]: {column: IDataMemberInfo, summaryFunctions: number[]}[]

The collection of summary settings.

masterDetailSummaryOptionsColumns Property

Specifies the collection of columns to calculate summaries.

Declaration

masterDetailSummaryOptionsColumns?: any

Property Value

Type Description
any

The collection of columns to calculate summaries.

newDataSource Property

Specifies a newly created data source.

Declaration

newDataSource?: string

Property Value

Type Description
string

The newly created data source.

pageSetup Property

Specifies the page settings.

Declaration

pageSetup: IPageSetup

Property Value

Type Description
IPageSetup

The page settings.

reportTitle Property

Specifies the report title.

Declaration

reportTitle?: string

Property Value

Type Description
string

The report title.

reportType Property

Specifies the report type.

Declaration

reportType?: ReportType

Property Value

Type Description
ReportType

The report type.