Back to Devexpress

ParametersPanelModelBase Class

xtrareports-js-devexpress-dot-reporting-dot-viewer-dot-parameters-bf916f9a.md

latest5.1 KB
Original Source

ParametersPanelModelBase Class

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

Declaration

ts
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

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

Parameters

NameType
parametersHolderReportHolder
parameterHelperPreviewParameterHelper
enableKeyboardSupportboolean
getRootElement(element: Element) => Element

Properties

buttons Property

Declaration

ts
buttons: Array<DevExpress.ui.dxButton.Properties>

Property Value

Type
Properties[]

lastValidationRequest Property

Declaration

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

Property Value

Type
DxDeferred<any>

parameterHelper Property

Declaration

ts
parameterHelper: DevExpress.Reporting.Viewer.Parameters.PreviewParameterHelper

Property Value

Type
PreviewParameterHelper

parameters Property

Declaration

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

Property Value

Type
PreviewParameter[]

parametersLoading Property

Declaration

ts
parametersLoading: boolean

Property Value

Type
boolean

prevParametersStateRequest Property

Declaration

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

Property Value

Type
DxDeferred<any>

processInvisibleParameters Property

Declaration

ts
processInvisibleParameters: boolean

Property Value

Type
boolean

restore Property

Declaration

ts
restore: () => void

Property Value

Type
() => void

showButtons Property

Declaration

ts
showButtons: boolean

Property Value

Type
boolean

submit Property

Declaration

ts
submit: () => void

Property Value

Type
() => void

tabInfo Property

Declaration

ts
tabInfo: DevExpress.Analytics.Utils.TabInfoWithPropertyGrid

Property Value

Type
TabInfoWithPropertyGrid

Methods

createViewModel Method

Declaration

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

Returns

Type
IParametersPanelViewModel

initialize(originalParametersInfo) Method

Declaration

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

Parameters

NameType
originalParametersInfoIReportParametersInfo

onPropertyChanged(args) Method

Declaration

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

Parameters

NameType
argsPropertyChangedEventArgs<ParametersPanelModelBase>

serializeParameters Method

Declaration

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

Returns

Type
IKeyValuePair<any>[]

setParameterValue(parameterName, value) Method

Declaration

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

Parameters

NameType
parameterNamestring
valueunknown

updateParameters(changedParameter) Method

Declaration

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

Parameters

NameType
changedParameterPreviewParameter

updateViewModel(args) Method

Declaration

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

Parameters

NameType
argsPropertyChangedEventArgs<any>