ParametersPanelModelBase Class

A base class that defines common properties and methods for client models of report parameters.

Declaration

export class ParametersPanelModelBase extends ParameterPanelItemBase<DevExpress.Reporting.Viewer.Parameters.IParametersPanelViewModel>

Inheritance

ParametersPanelModelBase

PreviewParametersPanelModel

ParametersPanelStandalone

constructor(parametersHolder)

Initializes a new instance of the ParametersPanelModelBase class with specified settings.

Declaration

constructor(
    parametersHolder: DevExpress.Reporting.Viewer.ReportHolder,
    parameterHelper?: DevExpress.Reporting.Viewer.Parameters.PreviewParameterHelper,
    enableKeyboardSupport?: boolean,
    getRootElement?: (element: Element) => Element
)

Parameters

Name	Type
parametersHolder	ReportHolder
parameterHelper	PreviewParameterHelper
enableKeyboardSupport	boolean
getRootElement	(element: Element) => Element

Properties

buttons Property

Declaration

buttons: Array<Properties>

Property Value

Type
Properties[]

lastValidationRequest Property

Declaration

lastValidationRequest: DevExpress.Analytics.Internal.DxDeferred<any>

Property Value

Type
DxDeferred<any>

parameterHelper Property

Declaration

parameterHelper: DevExpress.Reporting.Viewer.Parameters.PreviewParameterHelper

Property Value

Type
PreviewParameterHelper

parameters Property

Declaration

get parameters(): DevExpress.Reporting.Viewer.Parameters.PreviewParameter[]

Property Value

Type
PreviewParameter[]

parametersLoading Property

Declaration

parametersLoading: boolean

Property Value

Type
boolean

prevParametersStateRequest Property

Declaration

prevParametersStateRequest: DevExpress.Analytics.Internal.DxDeferred<any>

Property Value

Type
DxDeferred<any>

processInvisibleParameters Property

Declaration

processInvisibleParameters: boolean

Property Value

Type
boolean

restore Property

Declaration

restore: () => void

Property Value

Type
() => void

showButtons Property

Declaration

showButtons: boolean

Property Value

Type
boolean

submit Property

Declaration

submit: () => void

Property Value

Type
() => void

tabInfo Property

Declaration

tabInfo: DevExpress.Analytics.Utils.TabInfoWithPropertyGrid

Property Value

Type
TabInfoWithPropertyGrid

Methods

createViewModel Method

Declaration

createViewModel(): DevExpress.Reporting.Viewer.Parameters.IParametersPanelViewModel

Returns

Type
IParametersPanelViewModel

initialize(originalParametersInfo) Method

Declaration

initialize(
    originalParametersInfo: DevExpress.Reporting.Viewer.Parameters.IReportParametersInfo
): void

Parameters

Name	Type
originalParametersInfo	IReportParametersInfo

onPropertyChanged(args) Method

Declaration

onPropertyChanged(
    args: DevExpress.Analytics.Serializer.Native.PropertyChangedEventArgs<ParametersPanelModelBase> | DevExpress.Analytics.Serializer.Native.ArrayPropertyChangedEventArgs<ParametersPanelModelBase>
): void

Parameters

Name	Type
args	PropertyChangedEventArgs<ParametersPanelModelBase> | ArrayPropertyChangedEventArgs<ParametersPanelModelBase>

serializeParameters Method

Declaration

serializeParameters(): Array<DevExpress.Reporting.IKeyValuePair<any>>

Returns

Type
IKeyValuePair<any>[]

setParameterValue(parameterName, value) Method

Declaration

setParameterValue(
    parameterName: string,
    value: unknown
): void

Parameters

Name	Type
parameterName	string
value	unknown

updateParameters(changedParameter) Method

Declaration

updateParameters(
    changedParameter: DevExpress.Reporting.Viewer.Parameters.PreviewParameter
): void

Parameters

Name	Type
changedParameter	PreviewParameter

updateViewModel(args) Method

Declaration

updateViewModel(
    args: DevExpress.Analytics.Serializer.Native.PropertyChangedEventArgs<any> | DevExpress.Analytics.Serializer.Native.ArrayPropertyChangedEventArgs<any>
): void

Parameters

Name	Type
args	PropertyChangedEventArgs<any> | ArrayPropertyChangedEventArgs<any>