devexpress-reporting
Version:
DevExpress Reporting provides the capability to develop a reporting application to create and customize reports.
121 lines (120 loc) • 6.1 kB
TypeScript
/**
* DevExpress HTML/JS Reporting (designer\controls\xrControl.d.ts)
* Version: 25.1.3
* Build date: Jun 26, 2025
* Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED
* License: https://www.devexpress.com/Support/EULAs/universal.xml
*/
import { ElementViewModel, IArea, IElementViewModel, ISurfaceContext, SurfaceElementBase } from '@devexpress/analytics-core/analytics-elements';
import { DxPromise, ISelectionTarget, IUnitProperties } from '@devexpress/analytics-core/analytics-internal';
import { IModelSerializer } from '@devexpress/analytics-core/analytics-utils';
import { IExpressionOptions } from '@devexpress/analytics-core/analytics-widgets';
import * as ko from 'knockout';
import { DataBinding } from '../dataObjects/dataBinding';
import { HorizontalAnchoring, IAnchoringProperties, VerticalAcnhoring } from './properties/anchoring';
import { IExpressionBinding } from './properties/expressionBinding';
import { SortingOptions } from './properties/sortingOptions';
import { IReportControlMetadata } from './utils/controlsFactory';
import { ControlType } from './utils/_controlTypes';
import { XRReportElementViewModel } from './xrReportelement';
import { ActionTypeBase } from './properties/action';
declare enum FieldNameOptions {
DisplayName = 0,
RealName = 1
}
export declare class XRControlViewModel extends XRReportElementViewModel {
dispose(): void;
anchoring(parent: IAnchoringProperties): void;
beforeDeserialize(model: any, parent: ElementViewModel<ControlType>, serializer?: IModelSerializer): void;
_realText: ko.Computed<string> | ko.Observable<string>;
textUI: ko.Computed<string> | ko.Observable<string>;
_textUI: ko.Observable<string>;
_textArea: ko.Computed<string> | ko.Observable<string>;
getFieldName(value: string, fieldNameOption: FieldNameOptions): {
dataMember: string;
namePromise: DxPromise<string>;
};
setTextValue(fieldNamePromise: DxPromise<string>, originText: string, replacedText: string, propertyToSet: ko.Computed<string> | ko.Observable<string>): void;
constructor(control: any, parent: ElementViewModel<ControlType>, serializer?: IModelSerializer);
isIntersectionEnabled(): boolean;
getNearestParent(target: IElementViewModel<ControlType>): IElementViewModel<string>;
isPropertyDisabled(name: any): any;
isPropertyVisible(name: any): boolean;
hasExpressionBindings(): boolean;
hasDataBindingByName(property?: string): boolean;
get hasDefaultBindingProperty(): boolean;
getExpressionBinding(property?: string, event?: string): string;
setExpressionBinding(value: string, property?: string, event?: string): void;
getControlInfo(): IReportControlMetadata;
getDefaultBinding(): IExpressionOptions | DataBinding;
textArea: ko.Observable<string> | ko.Computed<string>;
multiline: ko.Observable<boolean> | ko.Computed<boolean>;
name: ko.Observable<string> | ko.Computed<string>;
text: ko.Observable<string> | ko.Computed<string>;
textFormatString: ko.Observable<string> | ko.Computed<string>;
controls: ko.ObservableArray<XRControlViewModel>;
popularDataBinding: any;
anchorVertical: ko.Observable<string> | ko.Computed<string>;
anchorHorizontal: ko.Observable<string> | ko.Computed<string>;
vertAnchoring: VerticalAcnhoring;
horAnchoring: HorizontalAnchoring;
hasBindings: ko.Computed<boolean>;
interactiveSorting: SortingOptions;
expressionBindings: ko.ObservableArray<IExpressionBinding>;
dataBindingsAreValid: ko.Observable<boolean> | ko.Computed<boolean>;
action?: ko.Observable<ActionTypeBase>;
}
export declare class XRControlSurfaceBase<M extends ElementViewModel<ControlType>> extends SurfaceElementBase<M, ControlType> {
private delta;
private _isThereIntersectionWithUsefulArea;
static _appendValue(accumulator: string, value: string, needToAppend?: boolean): string;
protected get _unitAbsoluteRect(): IArea;
private get _unitRect();
constructor(control: M, context: ISurfaceContext, unitProperties: IUnitProperties<M>);
checkParent(surfaceParent: ISelectionTarget): boolean;
isThereIntersection(rect1: IArea, rect2: IArea): boolean;
isThereIntersectionWithParent(parentRect: IArea, childRect: IArea): boolean;
isThereIntersectionWithUsefulArea(): boolean;
isThereIntersectionWithCrossBandControls(currentRect?: IArea): boolean;
isThereIntersectionWithControls(): boolean;
isThereIntersectionWithParentCollection(currentRect: any, controlRectProperty?: string): boolean;
isThereIntersectionWithChildCollection(controlRectProperty?: string): boolean;
isThereIntersectionWithNeighborsCollection(currentRect: any, collectionControls: any, controlRectProperty?: string): boolean;
isThereIntersectionWithChildControls(collectionControls: any, controlRectProperty?: string): boolean;
canSnap(): boolean;
getAdornTemplate(): string;
hasDataBindingByName(propertyName: string): boolean;
get hasBindings(): boolean;
get bindingsIsValid(): any;
get bindingsHasWarning(): any;
contentSizes: any;
contentHeightWithoutZoom: any;
contentWidthWithoutZoom: any;
borderCss: any;
template: string;
selectiontemplate: string;
contenttemplate: string;
isIntersect: ko.Computed<boolean>;
adorntemplate: ko.Computed<string>;
showDropBorders?: ko.Observable<boolean>;
displayNameParameters: ko.PureComputed<{
text: any;
isExpression: boolean;
dataSource: any;
dataMember: any;
dataMemberOffset: any;
allowMarkupText: boolean;
wordWrap: boolean;
fontSize: number;
fontUnit: any;
}>;
displayName: ko.PureComputed<any>;
displayText(): any;
}
export declare class XRControlSurface extends XRControlSurfaceBase<XRControlViewModel> {
dispose(): void;
static _unitProperties: IUnitProperties<XRControlViewModel>;
constructor(control: XRControlViewModel, context: ISurfaceContext);
controls: ko.ObservableArray<XRControlSurface>;
}
export {};