devextreme-angular

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 DxGallery from 'devextreme/ui/gallery'; import { DxComponent, DxTemplateHost, NestedOptionHost, IterableDifferHelper, WatcherHelper } from 'devextreme-angular/core'; import { DxiItemComponent } 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/gallery'; /** * The Gallery is a UI component that displays a collection of images in a carousel. The UI component is supplied with various navigation controls that allow a user to switch between images. */ export declare class DxGalleryComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck { private _watcherHelper; private _idh; instance: DxGallery; /** * Specifies the shortcut key that sets focus on the UI component. */ get accessKey(): string | undefined; set accessKey(value: string | undefined); /** * The time, in milliseconds, spent on slide animation. */ get animationDuration(): number; set animationDuration(value: number); /** * Specifies whether or not to animate the displayed item change. */ get animationEnabled(): boolean; set animationEnabled(value: boolean); /** * Binds the UI component to data. */ get dataSource(): DataSource | DataSourceOptions | Store | null | string | Array<string | DevExpress.ui.dxGalleryItem | any>; set dataSource(value: DataSource | DataSourceOptions | Store | null | string | Array<string | DevExpress.ui.dxGalleryItem | 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's container element. */ get elementAttr(): any; set elementAttr(value: any); /** * Specifies whether the UI component can be focused using keyboard navigation. */ get focusStateEnabled(): boolean; set focusStateEnabled(value: boolean); /** * Specifies the UI component's height. */ get height(): number | Function | string | undefined; set height(value: number | Function | string | undefined); /** * Specifies text for a hint that appears when a user pauses on the UI component. */ get hint(): string | undefined; set hint(value: string | undefined); /** * Specifies whether the UI component changes its state when a user pauses on it. */ get hoverStateEnabled(): boolean; set hoverStateEnabled(value: boolean); /** * A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. */ get indicatorEnabled(): boolean; set indicatorEnabled(value: boolean); /** * Specifies the width of an area used to display a single image. */ get initialItemWidth(): number | undefined; set initialItemWidth(value: number | undefined); /** * 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; imageAlt?: string; imageSrc?: string; template?: any; text?: string; }>; set items(value: Array<string | any | { disabled?: boolean; html?: string; imageAlt?: string; imageSrc?: string; template?: any; text?: string; }>); /** * Specifies a custom template for items. */ get itemTemplate(): any; set itemTemplate(value: any); /** * A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ get loop(): boolean; set loop(value: boolean); /** * Specifies the text or HTML markup displayed by the UI component if the item collection is empty. */ get noDataText(): string; set noDataText(value: string); /** * Switches the UI component to a right-to-left representation. */ get rtlEnabled(): boolean; set rtlEnabled(value: boolean); /** * The index of the currently active gallery item. */ get selectedIndex(): number; set selectedIndex(value: number); /** * The selected item object. */ get selectedItem(): any; set selectedItem(value: any); /** * A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. */ get showIndicator(): boolean; set showIndicator(value: boolean); /** * A Boolean value that specifies the availability of the 'Forward' and 'Back' navigation buttons. */ get showNavButtons(): boolean; set showNavButtons(value: boolean); /** * The time interval in milliseconds, after which the gallery switches to the next item. */ get slideshowDelay(): number; set slideshowDelay(value: number); /** * Specifies if the UI component stretches images to fit the total gallery width. */ get stretchImages(): boolean; set stretchImages(value: boolean); /** * A Boolean value specifying whether or not to allow users to switch between items by swiping. */ get swipeEnabled(): boolean; set swipeEnabled(value: boolean); /** * Specifies the number of the element when the Tab key is used for navigating. */ get tabIndex(): number; set tabIndex(value: number); /** * Specifies whether the UI component is visible. */ get visible(): boolean; set visible(value: boolean); /** * Specifies the UI component's width. */ get width(): number | Function | string | undefined; set width(value: number | Function | string | undefined); /** * Specifies whether or not to display parts of previous and next images along the sides of the current image. */ get wrapAround(): boolean; set wrapAround(value: boolean); /** * 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>; /** * A function that is executed when a collection item is selected or selection is canceled. */ onSelectionChanged: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ accessKeyChange: EventEmitter<string | undefined>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ animationDurationChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ animationEnabledChange: EventEmitter<boolean>; /** * 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.dxGalleryItem | 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. */ focusStateEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ heightChange: EventEmitter<number | Function | string | undefined>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hintChange: EventEmitter<string | undefined>; /** * 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. */ indicatorEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ initialItemWidthChange: EventEmitter<number | undefined>; /** * 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; imageAlt?: string; imageSrc?: string; template?: any; text?: string; }>>; /** * 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. */ loopChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ noDataTextChange: EventEmitter<string>; /** * 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. */ selectedIndexChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ selectedItemChange: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showIndicatorChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showNavButtonsChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ slideshowDelayChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ stretchImagesChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ swipeEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ tabIndexChange: EventEmitter<number>; /** * 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 | undefined>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ wrapAroundChange: EventEmitter<boolean>; get itemsChildren(): QueryList<DxiItemComponent>; set itemsChildren(value: QueryList<DxiItemComponent>); constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any); protected _createInstance(element: any, options: any): DxGallery<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<DxGalleryComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<DxGalleryComponent, "dx-gallery", never, { "accessKey": "accessKey"; "animationDuration": "animationDuration"; "animationEnabled": "animationEnabled"; "dataSource": "dataSource"; "disabled": "disabled"; "elementAttr": "elementAttr"; "focusStateEnabled": "focusStateEnabled"; "height": "height"; "hint": "hint"; "hoverStateEnabled": "hoverStateEnabled"; "indicatorEnabled": "indicatorEnabled"; "initialItemWidth": "initialItemWidth"; "itemHoldTimeout": "itemHoldTimeout"; "items": "items"; "itemTemplate": "itemTemplate"; "loop": "loop"; "noDataText": "noDataText"; "rtlEnabled": "rtlEnabled"; "selectedIndex": "selectedIndex"; "selectedItem": "selectedItem"; "showIndicator": "showIndicator"; "showNavButtons": "showNavButtons"; "slideshowDelay": "slideshowDelay"; "stretchImages": "stretchImages"; "swipeEnabled": "swipeEnabled"; "tabIndex": "tabIndex"; "visible": "visible"; "width": "width"; "wrapAround": "wrapAround"; }, { "onContentReady": "onContentReady"; "onDisposing": "onDisposing"; "onInitialized": "onInitialized"; "onItemClick": "onItemClick"; "onItemContextMenu": "onItemContextMenu"; "onItemHold": "onItemHold"; "onItemRendered": "onItemRendered"; "onOptionChanged": "onOptionChanged"; "onSelectionChanged": "onSelectionChanged"; "accessKeyChange": "accessKeyChange"; "animationDurationChange": "animationDurationChange"; "animationEnabledChange": "animationEnabledChange"; "dataSourceChange": "dataSourceChange"; "disabledChange": "disabledChange"; "elementAttrChange": "elementAttrChange"; "focusStateEnabledChange": "focusStateEnabledChange"; "heightChange": "heightChange"; "hintChange": "hintChange"; "hoverStateEnabledChange": "hoverStateEnabledChange"; "indicatorEnabledChange": "indicatorEnabledChange"; "initialItemWidthChange": "initialItemWidthChange"; "itemHoldTimeoutChange": "itemHoldTimeoutChange"; "itemsChange": "itemsChange"; "itemTemplateChange": "itemTemplateChange"; "loopChange": "loopChange"; "noDataTextChange": "noDataTextChange"; "rtlEnabledChange": "rtlEnabledChange"; "selectedIndexChange": "selectedIndexChange"; "selectedItemChange": "selectedItemChange"; "showIndicatorChange": "showIndicatorChange"; "showNavButtonsChange": "showNavButtonsChange"; "slideshowDelayChange": "slideshowDelayChange"; "stretchImagesChange": "stretchImagesChange"; "swipeEnabledChange": "swipeEnabledChange"; "tabIndexChange": "tabIndexChange"; "visibleChange": "visibleChange"; "widthChange": "widthChange"; "wrapAroundChange": "wrapAroundChange"; }, ["itemsChildren"], never>; } export declare class DxGalleryModule { static ɵfac: i0.ɵɵFactoryDeclaration<DxGalleryModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<DxGalleryModule, [typeof DxGalleryComponent], [typeof i1.DxiItemModule, typeof i2.DxIntegrationModule, typeof i2.DxTemplateModule, typeof i3.BrowserTransferStateModule], [typeof DxGalleryComponent, typeof i1.DxiItemModule, typeof i2.DxTemplateModule]>; static ɵinj: i0.ɵɵInjectorDeclaration<DxGalleryModule>; }