UNPKG

devextreme-angular

Version:

Angular UI and visualization components based on DevExtreme widgets

350 lines (279 loc) 13.4 kB
import { TransferState } from '@angular/platform-browser'; import { ElementRef, NgZone, OnDestroy, EventEmitter, OnChanges, DoCheck, SimpleChanges, QueryList } from '@angular/core'; import DevExpress from 'devextreme/bundles/dx.all'; import Store from 'devextreme/data/abstract_store'; import DataSource, { Options as DataSourceOptions } from 'devextreme/data/data_source'; import DxResponsiveBox from 'devextreme/ui/responsive_box'; import { DxComponent, DxTemplateHost, NestedOptionHost, IterableDifferHelper, WatcherHelper } from 'devextreme-angular/core'; import { DxiColComponent } from 'devextreme-angular/ui/nested'; import { DxiItemComponent } from 'devextreme-angular/ui/nested'; import { DxiRowComponent } from 'devextreme-angular/ui/nested'; import * as i0 from "@angular/core"; import * as i1 from "devextreme-angular/ui/nested"; import * as i2 from "devextreme-angular/core"; import * as i3 from "@angular/platform-browser"; export { ExplicitTypes } from 'devextreme/ui/responsive_box'; /** * The ResponsiveBox UI component allows you to create an application or a website with a layout adapted to different screen sizes. */ export declare class DxResponsiveBoxComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck { private _watcherHelper; private _idh; instance: DxResponsiveBox; /** * Specifies the collection of columns for the grid used to position layout elements. */ get cols(): Array<any | { baseSize?: number | string; ratio?: number; screen?: string | undefined; shrink?: number; }>; set cols(value: Array<any | { baseSize?: number | string; ratio?: number; screen?: string | undefined; shrink?: number; }>); /** * Binds the UI component to data. */ get dataSource(): DataSource | DataSourceOptions | Store | null | string | Array<string | DevExpress.ui.dxResponsiveBoxItem | any>; set dataSource(value: DataSource | DataSourceOptions | Store | null | string | Array<string | DevExpress.ui.dxResponsiveBoxItem | any>); /** * Specifies whether the UI component responds to user interaction. */ get disabled(): boolean; set disabled(value: boolean); /** * Specifies the global attributes to be attached to the UI component&apos;s container element. */ get elementAttr(): any; set elementAttr(value: any); /** * Specifies the UI component&apos;s height. */ get height(): number | Function | string; set height(value: number | Function | string); /** * Specifies whether the UI component changes its state when a user pauses on it. */ get hoverStateEnabled(): boolean; set hoverStateEnabled(value: boolean); /** * The time period in milliseconds before the onItemHold event is raised. */ get itemHoldTimeout(): number; set itemHoldTimeout(value: number); /** * An array of items displayed by the UI component. */ get items(): Array<string | any | { disabled?: boolean; html?: string; location?: Array<any | { col?: number; colspan?: number | undefined; row?: number; rowspan?: number | undefined; screen?: string | undefined; }>; template?: any; text?: string; visible?: boolean; }>; set items(value: Array<string | any | { disabled?: boolean; html?: string; location?: Array<any | { col?: number; colspan?: number | undefined; row?: number; rowspan?: number | undefined; screen?: string | undefined; }>; template?: any; text?: string; visible?: boolean; }>); /** * Specifies a custom template for items. */ get itemTemplate(): any; set itemTemplate(value: any); /** * Specifies the collection of rows for the grid used to position layout elements. */ get rows(): Array<any | { baseSize?: number | string; ratio?: number; screen?: string | undefined; shrink?: number; }>; set rows(value: Array<any | { baseSize?: number | string; ratio?: number; screen?: string | undefined; shrink?: number; }>); /** * Switches the UI component to a right-to-left representation. */ get rtlEnabled(): boolean; set rtlEnabled(value: boolean); /** * Specifies the function returning the size qualifier depending on the screen&apos;s width. */ get screenByWidth(): Function; set screenByWidth(value: Function); /** * Specifies on which screens all layout elements should be arranged in a single column. Accepts a single or several size qualifiers separated by a space. */ get singleColumnScreen(): string; set singleColumnScreen(value: string); /** * Specifies whether the UI component is visible. */ get visible(): boolean; set visible(value: boolean); /** * Specifies the UI component&apos;s width. */ get width(): number | Function | string; set width(value: number | Function | string); /** * A function that is executed when the UI component is rendered and each time the component is repainted. */ onContentReady: EventEmitter<any>; /** * A function that is executed before the UI component is disposed of. */ onDisposing: EventEmitter<any>; /** * A function used in JavaScript frameworks to save the UI component instance. */ onInitialized: EventEmitter<any>; /** * A function that is executed when a collection item is clicked or tapped. */ onItemClick: EventEmitter<any>; /** * A function that is executed when a collection item is right-clicked or pressed. */ onItemContextMenu: EventEmitter<any>; /** * A function that is executed when a collection item has been held for a specified period. */ onItemHold: EventEmitter<any>; /** * A function that is executed after a collection item is rendered. */ onItemRendered: EventEmitter<any>; /** * A function that is executed after a UI component property is changed. */ onOptionChanged: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ colsChange: EventEmitter<Array<any | { baseSize?: number | string; ratio?: number; screen?: string | undefined; shrink?: number; }>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ dataSourceChange: EventEmitter<DataSource | DataSourceOptions | Store | null | string | Array<string | DevExpress.ui.dxResponsiveBoxItem | any>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ disabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ elementAttrChange: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ heightChange: EventEmitter<number | Function | string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hoverStateEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemHoldTimeoutChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemsChange: EventEmitter<Array<string | any | { disabled?: boolean; html?: string; location?: Array<any | { col?: number; colspan?: number | undefined; row?: number; rowspan?: number | undefined; screen?: string | undefined; }>; template?: any; text?: string; visible?: boolean; }>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemTemplateChange: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ rowsChange: EventEmitter<Array<any | { baseSize?: number | string; ratio?: number; screen?: string | undefined; shrink?: number; }>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ rtlEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ screenByWidthChange: EventEmitter<Function>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ singleColumnScreenChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ visibleChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ widthChange: EventEmitter<number | Function | string>; get colsChildren(): QueryList<DxiColComponent>; set colsChildren(value: QueryList<DxiColComponent>); get itemsChildren(): QueryList<DxiItemComponent>; set itemsChildren(value: QueryList<DxiItemComponent>); get rowsChildren(): QueryList<DxiRowComponent>; set rowsChildren(value: QueryList<DxiRowComponent>); constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any); protected _createInstance(element: any, options: any): DxResponsiveBox<any, any>; ngOnDestroy(): void; ngOnChanges(changes: SimpleChanges): void; setupChanges(prop: string, changes: SimpleChanges): void; ngDoCheck(): void; _setOption(name: string, value: any): void; static ɵfac: i0.ɵɵFactoryDeclaration<DxResponsiveBoxComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<DxResponsiveBoxComponent, "dx-responsive-box", never, { "cols": "cols"; "dataSource": "dataSource"; "disabled": "disabled"; "elementAttr": "elementAttr"; "height": "height"; "hoverStateEnabled": "hoverStateEnabled"; "itemHoldTimeout": "itemHoldTimeout"; "items": "items"; "itemTemplate": "itemTemplate"; "rows": "rows"; "rtlEnabled": "rtlEnabled"; "screenByWidth": "screenByWidth"; "singleColumnScreen": "singleColumnScreen"; "visible": "visible"; "width": "width"; }, { "onContentReady": "onContentReady"; "onDisposing": "onDisposing"; "onInitialized": "onInitialized"; "onItemClick": "onItemClick"; "onItemContextMenu": "onItemContextMenu"; "onItemHold": "onItemHold"; "onItemRendered": "onItemRendered"; "onOptionChanged": "onOptionChanged"; "colsChange": "colsChange"; "dataSourceChange": "dataSourceChange"; "disabledChange": "disabledChange"; "elementAttrChange": "elementAttrChange"; "heightChange": "heightChange"; "hoverStateEnabledChange": "hoverStateEnabledChange"; "itemHoldTimeoutChange": "itemHoldTimeoutChange"; "itemsChange": "itemsChange"; "itemTemplateChange": "itemTemplateChange"; "rowsChange": "rowsChange"; "rtlEnabledChange": "rtlEnabledChange"; "screenByWidthChange": "screenByWidthChange"; "singleColumnScreenChange": "singleColumnScreenChange"; "visibleChange": "visibleChange"; "widthChange": "widthChange"; }, ["colsChildren", "itemsChildren", "rowsChildren"], never>; } export declare class DxResponsiveBoxModule { static ɵfac: i0.ɵɵFactoryDeclaration<DxResponsiveBoxModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<DxResponsiveBoxModule, [typeof DxResponsiveBoxComponent], [typeof i1.DxiColModule, typeof i1.DxiItemModule, typeof i1.DxiLocationModule, typeof i1.DxiRowModule, typeof i2.DxIntegrationModule, typeof i2.DxTemplateModule, typeof i3.BrowserTransferStateModule], [typeof DxResponsiveBoxComponent, typeof i1.DxiColModule, typeof i1.DxiItemModule, typeof i1.DxiLocationModule, typeof i1.DxiRowModule, typeof i2.DxTemplateModule]>; static ɵinj: i0.ɵɵInjectorDeclaration<DxResponsiveBoxModule>; }