devextreme-angular
Version:
Angular UI and visualization components based on DevExtreme widgets
358 lines (263 loc) • 13.1 kB
TypeScript
import { TransferState } from '@angular/platform-browser';
import { ElementRef, NgZone, OnDestroy, EventEmitter } from '@angular/core';
import { UserDefinedElement } from 'devextreme/core/element';
import DxSortable from 'devextreme/ui/sortable';
import { DxComponent, DxTemplateHost, NestedOptionHost, WatcherHelper } from 'devextreme-angular/core';
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";
/**
* Sortable is a user interface utility that allows a UI component's items to be reordered via drag and drop gestures.
*/
export declare class DxSortableComponent extends DxComponent implements OnDestroy {
instance: DxSortable;
/**
* Allows a user to drop an item inside another item.
*/
get allowDropInsideItem(): boolean;
set allowDropInsideItem(value: boolean);
/**
* Allows a user to reorder sortable items.
*/
get allowReordering(): boolean;
set allowReordering(value: boolean);
/**
* Enables automatic scrolling while dragging an item beyond the viewport.
*/
get autoScroll(): boolean;
set autoScroll(value: boolean);
/**
* Specifies a DOM element that limits the dragging area.
*/
get boundary(): string | UserDefinedElement | undefined;
set boundary(value: string | UserDefinedElement | undefined);
/**
* Specifies a custom container in which the draggable item should be rendered.
*/
get container(): string | UserDefinedElement | undefined;
set container(value: string | UserDefinedElement | undefined);
/**
* Specifies the cursor offset from the dragged item.
*/
get cursorOffset(): string | {
x?: number;
y?: number;
};
set cursorOffset(value: string | {
x?: number;
y?: number;
});
/**
* A container for custom data.
*/
get data(): any | undefined;
set data(value: any | undefined);
/**
* Specifies the directions in which an item can be dragged.
*/
get dragDirection(): string;
set dragDirection(value: string);
/**
* Specifies custom markup to be shown instead of the item being dragged.
*/
get dragTemplate(): any | undefined;
set dragTemplate(value: any | undefined);
/**
* Specifies how to highlight the item's drop position.
*/
get dropFeedbackMode(): string;
set dropFeedbackMode(value: string);
/**
* Specifies the global attributes to be attached to the UI component's container element.
*/
get elementAttr(): any;
set elementAttr(value: any);
/**
* Specifies a CSS selector for the items that can be dragged.
*/
get filter(): string;
set filter(value: string);
/**
* Allows you to group several UI components, so that users can drag and drop items between them.
*/
get group(): string | undefined;
set group(value: string | undefined);
/**
* Specifies a CSS selector (ID or class) that should act as the drag handle(s) for the item(s).
*/
get handle(): string;
set handle(value: string);
/**
* Specifies the UI component's height.
*/
get height(): number | Function | string | undefined;
set height(value: number | Function | string | undefined);
/**
* Notifies the UI component of the items' orientation.
*/
get itemOrientation(): string;
set itemOrientation(value: string);
/**
* Moves an element in the HTML markup when it is dropped.
*/
get moveItemOnDrop(): boolean;
set moveItemOnDrop(value: boolean);
/**
* Switches the UI component to a right-to-left representation.
*/
get rtlEnabled(): boolean;
set rtlEnabled(value: boolean);
/**
* Specifies the distance in pixels from the edge of viewport at which scrolling should start. Applies only if autoScroll is true.
*/
get scrollSensitivity(): number;
set scrollSensitivity(value: number);
/**
* Specifies the scrolling speed when dragging an item beyond the viewport. Applies only if autoScroll is true.
*/
get scrollSpeed(): number;
set scrollSpeed(value: number);
/**
* Specifies the UI component's width.
*/
get width(): number | Function | string | undefined;
set width(value: number | Function | string | undefined);
/**
* A function that is called when a new item is added.
*/
onAdd: EventEmitter<any>;
/**
* A function that is executed before the UI component is disposed of.
*/
onDisposing: EventEmitter<any>;
/**
* A function that is called when the dragged item's position in the list is changed.
*/
onDragChange: EventEmitter<any>;
/**
* A function that is called when the drag gesture is finished.
*/
onDragEnd: EventEmitter<any>;
/**
* A function that is called every time a draggable item is moved.
*/
onDragMove: EventEmitter<any>;
/**
* A function that is called when drag gesture is initialized.
*/
onDragStart: EventEmitter<any>;
/**
* A function used in JavaScript frameworks to save the UI component instance.
*/
onInitialized: EventEmitter<any>;
/**
* A function that is executed after a UI component property is changed.
*/
onOptionChanged: EventEmitter<any>;
/**
* A function that is called when a draggable item is removed.
*/
onRemove: EventEmitter<any>;
/**
* A function that is called when the draggable items are reordered.
*/
onReorder: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
allowDropInsideItemChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
allowReorderingChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
autoScrollChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
boundaryChange: EventEmitter<string | UserDefinedElement | undefined>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
containerChange: EventEmitter<string | UserDefinedElement | undefined>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
cursorOffsetChange: EventEmitter<string | {
x?: number;
y?: number;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
dataChange: EventEmitter<any | undefined>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
dragDirectionChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
dragTemplateChange: EventEmitter<any | undefined>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
dropFeedbackModeChange: EventEmitter<string>;
/**
* 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.
*/
filterChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
groupChange: EventEmitter<string | undefined>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
handleChange: EventEmitter<string>;
/**
* 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.
*/
itemOrientationChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
moveItemOnDropChange: EventEmitter<boolean>;
/**
* 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.
*/
scrollSensitivityChange: EventEmitter<number>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
scrollSpeedChange: EventEmitter<number>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
widthChange: EventEmitter<number | Function | string | undefined>;
constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
protected _createInstance(element: any, options: any): DxSortable;
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<DxSortableComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<DxSortableComponent, "dx-sortable", never, { "allowDropInsideItem": "allowDropInsideItem"; "allowReordering": "allowReordering"; "autoScroll": "autoScroll"; "boundary": "boundary"; "container": "container"; "cursorOffset": "cursorOffset"; "data": "data"; "dragDirection": "dragDirection"; "dragTemplate": "dragTemplate"; "dropFeedbackMode": "dropFeedbackMode"; "elementAttr": "elementAttr"; "filter": "filter"; "group": "group"; "handle": "handle"; "height": "height"; "itemOrientation": "itemOrientation"; "moveItemOnDrop": "moveItemOnDrop"; "rtlEnabled": "rtlEnabled"; "scrollSensitivity": "scrollSensitivity"; "scrollSpeed": "scrollSpeed"; "width": "width"; }, { "onAdd": "onAdd"; "onDisposing": "onDisposing"; "onDragChange": "onDragChange"; "onDragEnd": "onDragEnd"; "onDragMove": "onDragMove"; "onDragStart": "onDragStart"; "onInitialized": "onInitialized"; "onOptionChanged": "onOptionChanged"; "onRemove": "onRemove"; "onReorder": "onReorder"; "allowDropInsideItemChange": "allowDropInsideItemChange"; "allowReorderingChange": "allowReorderingChange"; "autoScrollChange": "autoScrollChange"; "boundaryChange": "boundaryChange"; "containerChange": "containerChange"; "cursorOffsetChange": "cursorOffsetChange"; "dataChange": "dataChange"; "dragDirectionChange": "dragDirectionChange"; "dragTemplateChange": "dragTemplateChange"; "dropFeedbackModeChange": "dropFeedbackModeChange"; "elementAttrChange": "elementAttrChange"; "filterChange": "filterChange"; "groupChange": "groupChange"; "handleChange": "handleChange"; "heightChange": "heightChange"; "itemOrientationChange": "itemOrientationChange"; "moveItemOnDropChange": "moveItemOnDropChange"; "rtlEnabledChange": "rtlEnabledChange"; "scrollSensitivityChange": "scrollSensitivityChange"; "scrollSpeedChange": "scrollSpeedChange"; "widthChange": "widthChange"; }, never, ["*"]>;
}
export declare class DxSortableModule {
static ɵfac: i0.ɵɵFactoryDeclaration<DxSortableModule, never>;
static ɵmod: i0.ɵɵNgModuleDeclaration<DxSortableModule, [typeof DxSortableComponent], [typeof i1.DxoCursorOffsetModule, typeof i2.DxIntegrationModule, typeof i2.DxTemplateModule, typeof i3.BrowserTransferStateModule], [typeof DxSortableComponent, typeof i1.DxoCursorOffsetModule, typeof i2.DxTemplateModule]>;
static ɵinj: i0.ɵɵInjectorDeclaration<DxSortableModule>;
}