@angular/cdk

{ "repo": "angular/components", "moduleLabel": "@angular/cdk/drag-drop", "moduleName": "@angular/cdk/drag-drop", "normalizedModuleName": "angular_cdk_drag-drop", "entries": [ { "name": "moveItemInArray", "signatures": [ { "name": "moveItemInArray", "entryType": "function", "description": "Moves an item one index in an array to another.", "generics": [ { "name": "T", "default": "any" } ], "isNewType": false, "jsdocTags": [ { "name": "param", "comment": "Array in which to move the item." }, { "name": "param", "comment": "Starting index of the item." }, { "name": "param", "comment": "Index to which the item should be moved." } ], "params": [ { "name": "array", "description": "Array in which to move the item.", "type": "T[]", "isOptional": false, "isRestParam": false }, { "name": "fromIndex", "description": "Starting index of the item.", "type": "number", "isOptional": false, "isRestParam": false }, { "name": "toIndex", "description": "Index to which the item should be moved.", "type": "number", "isOptional": false, "isRestParam": false } ], "rawComment": "/**\n * Moves an item one index in an array to another.\n * @param array Array in which to move the item.\n * @param fromIndex Starting index of the item.\n * @param toIndex Index to which the item should be moved.\n */", "returnType": "void" } ], "implementation": { "params": [ { "name": "array", "description": "Array in which to move the item.", "type": "T[]", "isOptional": false, "isRestParam": false }, { "name": "fromIndex", "description": "Starting index of the item.", "type": "number", "isOptional": false, "isRestParam": false }, { "name": "toIndex", "description": "Index to which the item should be moved.", "type": "number", "isOptional": false, "isRestParam": false } ], "isNewType": false, "returnType": "void", "generics": [ { "name": "T", "default": "any" } ], "name": "moveItemInArray", "description": "Moves an item one index in an array to another.", "entryType": "function", "jsdocTags": [ { "name": "param", "comment": "Array in which to move the item." }, { "name": "param", "comment": "Starting index of the item." }, { "name": "param", "comment": "Index to which the item should be moved." } ], "rawComment": "/**\n * Moves an item one index in an array to another.\n * @param array Array in which to move the item.\n * @param fromIndex Starting index of the item.\n * @param toIndex Index to which the item should be moved.\n */" }, "entryType": "function", "description": "Moves an item one index in an array to another.", "jsdocTags": [ { "name": "param", "comment": "Array in which to move the item." }, { "name": "param", "comment": "Starting index of the item." }, { "name": "param", "comment": "Index to which the item should be moved." } ], "rawComment": "/**\n * Moves an item one index in an array to another.\n * @param array Array in which to move the item.\n * @param fromIndex Starting index of the item.\n * @param toIndex Index to which the item should be moved.\n */", "source": { "filePath": "/src/cdk/drag-drop/drag-utils.ts", "startLine": 15, "endLine": 31 } }, { "name": "CdkDragStart", "isAbstract": false, "entryType": "interface", "members": [ { "name": "source", "type": "CdkDrag<T>", "memberType": "property", "memberTags": [], "description": "Draggable that emitted the event.", "jsdocTags": [] }, { "name": "event", "type": "MouseEvent | TouchEvent", "memberType": "property", "memberTags": [], "description": "Native event that started the drag sequence.", "jsdocTags": [] } ], "generics": [ { "name": "T", "default": "any" } ], "description": "Event emitted when the user starts dragging a draggable.", "jsdocTags": [], "rawComment": "/** Event emitted when the user starts dragging a draggable. */", "implements": [], "source": { "filePath": "/src/cdk/drag-drop/drag-events.ts", "startLine": 13, "endLine": 18 } }, { "name": "DragStartDelay", "type": "number | {touch: number; mouse: number}", "entryType": "type_alias", "generics": [], "rawComment": "/** Possible values that can be used to configure the drag start delay. */", "description": "Possible values that can be used to configure the drag start delay.", "jsdocTags": [], "source": { "filePath": "src/cdk/drag-drop/directives/config.ts", "startLine": 13, "endLine": 13 } }, { "name": "DragAxis", "type": "'x' | 'y'", "entryType": "type_alias", "generics": [], "rawComment": "/** Possible axis along which dragging can be locked. */", "description": "Possible axis along which dragging can be locked.", "jsdocTags": [], "source": { "filePath": "src/cdk/drag-drop/directives/config.ts", "startLine": 16, "endLine": 16 } }, { "name": "CDK_DRAG_PARENT", "type": "any", "entryType": "constant", "rawComment": "/**\n * Injection token that can be used for a `CdkDrag` to provide itself as a parent to the\n * drag-specific child directive (`CdkDragHandle`, `CdkDragPreview` etc.). Used primarily\n * to avoid circular imports.\n * @docs-private\n */", "description": "Injection token that can be used for a `CdkDrag` to provide itself as a parent to the\ndrag-specific child directive (`CdkDragHandle`, `CdkDragPreview` etc.). Used primarily\nto avoid circular imports.", "jsdocTags": [ { "name": "docs-private", "comment": "" } ], "source": { "filePath": "/src/cdk/drag-drop/drag-parent.ts", "startLine": 18, "endLine": 18 } }, { "name": "DragConstrainPosition", "type": "(point: Point, dragRef: DragRef) => Point", "entryType": "type_alias", "generics": [], "rawComment": "/** Function that can be used to constrain the position of a dragged element. */", "description": "Function that can be used to constrain the position of a dragged element.", "jsdocTags": [], "source": { "filePath": "src/cdk/drag-drop/directives/config.ts", "startLine": 19, "endLine": 19 } }, { "name": "CDK_DROP_LIST_GROUP", "type": "any", "entryType": "constant", "rawComment": "/**\n * Injection token that can be used to reference instances of `CdkDropListGroup`. It serves as\n * alternative token to the actual `CdkDropListGroup` class which could cause unnecessary\n * retention of the class and its directive metadata.\n */", "description": "Injection token that can be used to reference instances of `CdkDropListGroup`. It serves as\nalternative token to the actual `CdkDropListGroup` class which could cause unnecessary\nretention of the class and its directive metadata.", "jsdocTags": [], "source": { "filePath": "/src/cdk/drag-drop/directives/drop-list-group.ts", "startLine": 16, "endLine": 18 } }, { "name": "CdkDragRelease", "isAbstract": false, "entryType": "interface", "members": [ { "name": "source", "type": "CdkDrag<T>", "memberType": "property", "memberTags": [], "description": "Draggable that emitted the event.", "jsdocTags": [] }, { "name": "event", "type": "MouseEvent | TouchEvent", "memberType": "property", "memberTags": [], "description": "Native event that caused the release event.", "jsdocTags": [] } ], "generics": [ { "name": "T", "default": "any" } ], "description": "Event emitted when the user releases an item, before any animations have started.", "jsdocTags": [], "rawComment": "/** Event emitted when the user releases an item, before any animations have started. */", "implements": [], "source": { "filePath": "/src/cdk/drag-drop/drag-events.ts", "startLine": 21, "endLine": 26 } }, { "name": "CDK_DRAG_PLACEHOLDER", "type": "any", "entryType": "constant", "rawComment": "/**\n * Injection token that can be used to reference instances of `CdkDragPlaceholder`. It serves as\n * alternative token to the actual `CdkDragPlaceholder` class which could cause unnecessary\n * retention of the class and its directive metadata.\n */", "description": "Injection token that can be used to reference instances of `CdkDragPlaceholder`. It serves as\nalternative token to the actual `CdkDragPlaceholder` class which could cause unnecessary\nretention of the class and its directive metadata.", "jsdocTags": [], "source": { "filePath": "/src/cdk/drag-drop/directives/drag-placeholder.ts", "startLine": 17, "endLine": 17 } }, { "name": "CDK_DRAG_PREVIEW", "type": "any", "entryType": "constant", "rawComment": "/**\n * Injection token that can be used to reference instances of `CdkDragPreview`. It serves as\n * alternative token to the actual `CdkDragPreview` class which could cause unnecessary\n * retention of the class and its directive metadata.\n */", "description": "Injection token that can be used to reference instances of `CdkDragPreview`. It serves as\nalternative token to the actual `CdkDragPreview` class which could cause unnecessary\nretention of the class and its directive metadata.", "jsdocTags": [], "source": { "filePath": "/src/cdk/drag-drop/directives/drag-preview.ts", "startLine": 25, "endLine": 25 } }, { "name": "CdkDropListGroup", "isAbstract": false, "entryType": "undecorated_class", "members": [ { "name": "disabled", "type": "boolean", "memberType": "property", "memberTags": [], "description": "Whether starting a dragging sequence from inside this group is disabled.", "jsdocTags": [] }, { "name": "ngOnDestroy", "signatures": [ { "name": "ngOnDestroy", "entryType": "function", "description": "", "generics": [], "isNewType": false, "jsdocTags": [], "params": [], "rawComment": "", "returnType": "void" } ], "implementation": { "params": [], "isNewType": false, "returnType": "void", "generics": [], "name": "ngOnDestroy", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "" }, "entryType": "function", "description": "", "jsdocTags": [], "rawComment": "", "memberType": "method", "memberTags": [] } ], "generics": [ { "name": "T" } ], "description": "Declaratively connects sibling `cdkDropList` instances together. All of the `cdkDropList`\nelements that are placed inside a `cdkDropListGroup` will be connected to each other\nautomatically. Can be used as an alternative to the `cdkDropListConnectedTo` input\nfrom `cdkDropList`.", "jsdocTags": [], "rawComment": "/**\n * Declaratively connects sibling `cdkDropList` instances together. All of the `cdkDropList`\n * elements that are placed inside a `cdkDropListGroup` will be connected to each other\n * automatically. Can be used as an alternative to the `cdkDropListConnectedTo` input\n * from `cdkDropList`.\n */", "implements": [ "OnDestroy" ], "source": { "filePath": "/src/cdk/drag-drop/directives/drop-list-group.ts", "startLine": 26, "endLine": 42 } }, { "name": "DragDrop", "isAbstract": false, "entryType": "undecorated_class", "members": [ { "name": "constructor", "signatures": [ { "name": "constructor", "params": [ { "name": "args", "description": "", "type": "unknown[]", "isOptional": false, "isRestParam": true } ], "returnType": "DragDrop", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "", "generics": [], "isNewType": false } ], "implementation": { "params": [], "isNewType": false, "returnType": "DragDrop", "generics": [], "name": "constructor", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "" }, "entryType": "function", "description": "", "jsdocTags": [], "rawComment": "", "memberType": "method", "memberTags": [] }, { "name": "createDrag", "signatures": [ { "name": "createDrag", "entryType": "function", "description": "Turns an element into a draggable item.", "generics": [ { "name": "T", "default": "any" } ], "isNewType": false, "jsdocTags": [ { "name": "param", "comment": "Element to which to attach the dragging functionality." }, { "name": "param", "comment": "Object used to configure the dragging behavior." } ], "params": [ { "name": "element", "description": "Element to which to attach the dragging functionality.", "type": "any", "isOptional": false, "isRestParam": false }, { "name": "config", "description": "Object used to configure the dragging behavior.", "type": "DragRefConfig", "isOptional": true, "isRestParam": false } ], "rawComment": "/**\n * Turns an element into a draggable item.\n * @param element Element to which to attach the dragging functionality.\n * @param config Object used to configure the dragging behavior.\n */", "returnType": "DragRef<T>" } ], "implementation": { "params": [ { "name": "element", "description": "Element to which to attach the dragging functionality.", "type": "any", "isOptional": false, "isRestParam": false }, { "name": "config", "description": "Object used to configure the dragging behavior.", "type": "DragRefConfig", "isOptional": true, "isRestParam": false } ], "isNewType": false, "returnType": "DragRef<T>", "generics": [ { "name": "T", "default": "any" } ], "name": "createDrag", "description": "Turns an element into a draggable item.", "entryType": "function", "jsdocTags": [ { "name": "param", "comment": "Element to which to attach the dragging functionality." }, { "name": "param", "comment": "Object used to configure the dragging behavior." } ], "rawComment": "/**\n * Turns an element into a draggable item.\n * @param element Element to which to attach the dragging functionality.\n * @param config Object used to configure the dragging behavior.\n */" }, "entryType": "function", "description": "Turns an element into a draggable item.", "jsdocTags": [ { "name": "param", "comment": "Element to which to attach the dragging functionality." }, { "name": "param", "comment": "Object used to configure the dragging behavior." } ], "rawComment": "/**\n * Turns an element into a draggable item.\n * @param element Element to which to attach the dragging functionality.\n * @param config Object used to configure the dragging behavior.\n */", "memberType": "method", "memberTags": [] }, { "name": "createDropList", "signatures": [ { "name": "createDropList", "entryType": "function", "description": "Turns an element into a drop list.", "generics": [ { "name": "T", "default": "any" } ], "isNewType": false, "jsdocTags": [ { "name": "param", "comment": "Element to which to attach the drop list functionality." } ], "params": [ { "name": "element", "description": "Element to which to attach the drop list functionality.", "type": "any", "isOptional": false, "isRestParam": false } ], "rawComment": "/**\n * Turns an element into a drop list.\n * @param element Element to which to attach the drop list functionality.\n */", "returnType": "DropListRef<T>" } ], "implementation": { "params": [ { "name": "element", "description": "Element to which to attach the drop list functionality.", "type": "any", "isOptional": false, "isRestParam": false } ], "isNewType": false, "returnType": "DropListRef<T>", "generics": [ { "name": "T", "default": "any" } ], "name": "createDropList", "description": "Turns an element into a drop list.", "entryType": "function", "jsdocTags": [ { "name": "param", "comment": "Element to which to attach the drop list functionality." } ], "rawComment": "/**\n * Turns an element into a drop list.\n * @param element Element to which to attach the drop list functionality.\n */" }, "entryType": "function", "description": "Turns an element into a drop list.", "jsdocTags": [ { "name": "param", "comment": "Element to which to attach the drop list functionality." } ], "rawComment": "/**\n * Turns an element into a drop list.\n * @param element Element to which to attach the drop list functionality.\n */", "memberType": "method", "memberTags": [] } ], "generics": [], "description": "Service that allows for drag-and-drop functionality to be attached to DOM elements.", "jsdocTags": [], "rawComment": "/**\n * Service that allows for drag-and-drop functionality to be attached to DOM elements.\n */", "implements": [], "source": { "filePath": "/src/cdk/drag-drop/drag-drop.ts", "startLine": 25, "endLine": 69 } }, { "name": "CdkDragPlaceholder", "isAbstract": false, "entryType": "directive", "members": [ { "name": "constructor", "signatures": [ { "name": "constructor", "params": [ { "name": "args", "description": "", "type": "unknown[]", "isOptional": false, "isRestParam": true } ], "returnType": "CdkDragPlaceholder", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "", "generics": [], "isNewType": false } ], "implementation": { "params": [], "isNewType": false, "returnType": "CdkDragPlaceholder<T>", "generics": [], "name": "constructor", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "" }, "entryType": "function", "description": "", "jsdocTags": [], "rawComment": "", "memberType": "method", "memberTags": [] }, { "name": "templateRef", "type": "any", "memberType": "property", "memberTags": [], "description": "", "jsdocTags": [] }, { "name": "data", "type": "T", "memberType": "property", "memberTags": [ "input" ], "description": "Context data to be added to the placeholder template instance.", "jsdocTags": [], "inputAlias": "data", "isRequiredInput": false }, { "name": "ngOnDestroy", "signatures": [ { "name": "ngOnDestroy", "entryType": "function", "description": "", "generics": [], "isNewType": false, "jsdocTags": [], "params": [], "rawComment": "", "returnType": "void" } ], "implementation": { "params": [], "isNewType": false, "returnType": "void", "generics": [], "name": "ngOnDestroy", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "" }, "entryType": "function", "description": "", "jsdocTags": [], "rawComment": "", "memberType": "method", "memberTags": [] } ], "generics": [ { "name": "T", "default": "any" } ], "description": "Element that will be used as a template for the placeholder of a CdkDrag when\nit is being dragged. The placeholder is displayed in place of the element being dragged.", "jsdocTags": [], "rawComment": "/**\n * Element that will be used as a template for the placeholder of a CdkDrag when\n * it is being dragged. The placeholder is displayed in place of the element being dragged.\n */", "implements": [ "OnDestroy" ], "isStandalone": true, "selector": "ng-template[cdkDragPlaceholder]", "exportAs": [], "source": { "filePath": "/src/cdk/drag-drop/directives/drag-placeholder.ts", "startLine": 23, "endLine": 44 } }, { "name": "DropListOrientation", "type": "'horizontal' | 'vertical' | 'mixed'", "entryType": "type_alias", "generics": [], "rawComment": "/** Possible orientations for a drop list. */", "description": "Possible orientations for a drop list.", "jsdocTags": [], "source": { "filePath": "src/cdk/drag-drop/directives/config.ts", "startLine": 22, "endLine": 22 } }, { "name": "CdkDragPreview", "isAbstract": false, "entryType": "undecorated_class", "members": [ { "name": "constructor", "signatures": [ { "name": "constructor", "params": [ { "name": "args", "description": "", "type": "unknown[]", "isOptional": false, "isRestParam": true } ], "returnType": "CdkDragPreview", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "", "generics": [], "isNewType": false } ], "implementation": { "params": [], "isNewType": false, "returnType": "CdkDragPreview<T>", "generics": [], "name": "constructor", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "" }, "entryType": "function", "description": "", "jsdocTags": [], "rawComment": "", "memberType": "method", "memberTags": [] }, { "name": "templateRef", "type": "any", "memberType": "property", "memberTags": [], "description": "", "jsdocTags": [] }, { "name": "data", "type": "T", "memberType": "property", "memberTags": [], "description": "Context data to be added to the preview template instance.", "jsdocTags": [] }, { "name": "matchSize", "type": "boolean", "memberType": "property", "memberTags": [], "description": "Whether the preview should preserve the same size as the item that is being dragged.", "jsdocTags": [] }, { "name": "ngOnDestroy", "signatures": [ { "name": "ngOnDestroy", "entryType": "function", "description": "", "generics": [], "isNewType": false, "jsdocTags": [], "params": [], "rawComment": "", "returnType": "void" } ], "implementation": { "params": [], "isNewType": false, "returnType": "void", "generics": [], "name": "ngOnDestroy", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "" }, "entryType": "function", "description": "", "jsdocTags": [], "rawComment": "", "memberType": "method", "memberTags": [] } ], "generics": [ { "name": "T", "default": "any" } ], "description": "Element that will be used as a template for the preview\nof a CdkDrag when it is being dragged.", "jsdocTags": [], "rawComment": "/**\n * Element that will be used as a template for the preview\n * of a CdkDrag when it is being dragged.\n */", "implements": [ "OnDestroy" ], "source": { "filePath": "/src/cdk/drag-drop/directives/drag-preview.ts", "startLine": 31, "endLine": 55 } }, { "name": "DragDropModule", "isAbstract": false, "entryType": "undecorated_class", "members": [], "generics": [], "description": "", "jsdocTags": [], "rawComment": "", "implements": [], "source": { "filePath": "src/cdk/drag-drop/drag-drop-module.ts", "startLine": 28, "endLine": 33 } }, { "name": "CDK_DRAG_HANDLE", "type": "any", "entryType": "constant", "rawComment": "/**\n * Injection token that can be used to reference instances of `CdkDragHandle`. It serves as\n * alternative token to the actual `CdkDragHandle` class which could cause unnecessary\n * retention of the class and its directive metadata.\n */", "description": "Injection token that can be used to reference instances of `CdkDragHandle`. It serves as\nalternative token to the actual `CdkDragHandle` class which could cause unnecessary\nretention of the class and its directive metadata.", "jsdocTags": [], "source": { "filePath": "/src/cdk/drag-drop/directives/drag-handle.ts", "startLine": 30, "endLine": 30 } }, { "name": "transferArrayItem", "signatures": [ { "name": "transferArrayItem", "entryType": "function", "description": "Moves an item from one array to another.", "generics": [ { "name": "T", "default": "any" } ], "isNewType": false, "jsdocTags": [ { "name": "param", "comment": "Array from which to transfer the item." }, { "name": "param", "comment": "Array into which to put the item." }, { "name": "param", "comment": "Index of the item in its current array." }, { "name": "param", "comment": "Index at which to insert the item." } ], "params": [ { "name": "currentArray", "description": "Array from which to transfer the item.", "type": "T[]", "isOptional": false, "isRestParam": false }, { "name": "targetArray", "description": "Array into which to put the item.", "type": "T[]", "isOptional": false, "isRestParam": false }, { "name": "currentIndex", "description": "Index of the item in its current array.", "type": "number", "isOptional": false, "isRestParam": false }, { "name": "targetIndex", "description": "Index at which to insert the item.", "type": "number", "isOptional": false, "isRestParam": false } ], "rawComment": "/**\n * Moves an item from one array to another.\n * @param currentArray Array from which to transfer the item.\n * @param targetArray Array into which to put the item.\n * @param currentIndex Index of the item in its current array.\n * @param targetIndex Index at which to insert the item.\n */", "returnType": "void" } ], "implementation": { "params": [ { "name": "currentArray", "description": "Array from which to transfer the item.", "type": "T[]", "isOptional": false, "isRestParam": false }, { "name": "targetArray", "description": "Array into which to put the item.", "type": "T[]", "isOptional": false, "isRestParam": false }, { "name": "currentIndex", "description": "Index of the item in its current array.", "type": "number", "isOptional": false, "isRestParam": false }, { "name": "targetIndex", "description": "Index at which to insert the item.", "type": "number", "isOptional": false, "isRestParam": false } ], "isNewType": false, "returnType": "void", "generics": [ { "name": "T", "default": "any" } ], "name": "transferArrayItem", "description": "Moves an item from one array to another.", "entryType": "function", "jsdocTags": [ { "name": "param", "comment": "Array from which to transfer the item." }, { "name": "param", "comment": "Array into which to put the item." }, { "name": "param", "comment": "Index of the item in its current array." }, { "name": "param", "comment": "Index at which to insert the item." } ], "rawComment": "/**\n * Moves an item from one array to another.\n * @param currentArray Array from which to transfer the item.\n * @param targetArray Array into which to put the item.\n * @param currentIndex Index of the item in its current array.\n * @param targetIndex Index at which to insert the item.\n */" }, "entryType": "function", "description": "Moves an item from one array to another.", "jsdocTags": [ { "name": "param", "comment": "Array from which to transfer the item." }, { "name": "param", "comment": "Array into which to put the item." }, { "name": "param", "comment": "Index of the item in its current array." }, { "name": "param", "comment": "Index at which to insert the item." } ], "rawComment": "/**\n * Moves an item from one array to another.\n * @param currentArray Array from which to transfer the item.\n * @param targetArray Array into which to put the item.\n * @param currentIndex Index of the item in its current array.\n * @param targetIndex Index at which to insert the item.\n */", "source": { "filePath": "/src/cdk/drag-drop/drag-utils.ts", "startLine": 40, "endLine": 52 } }, { "name": "CdkDragEnd", "isAbstract": false, "entryType": "interface", "members": [ { "name": "source", "type": "CdkDrag<T>", "memberType": "property", "memberTags": [], "description": "Draggable that emitted the event.", "jsdocTags": [] }, { "name": "distance", "type": "{ x: number; y: number; }", "memberType": "property", "memberTags": [], "description": "Distance in pixels that the user has dragged since the drag sequence started.", "jsdocTags": [] }, { "name": "dropPoint", "type": "{ x: number; y: number; }", "memberType": "property", "memberTags": [], "description": "Position where the pointer was when the item was dropped", "jsdocTags": [] }, { "name": "event", "type": "MouseEvent | TouchEvent", "memberType": "property", "memberTags": [], "description": "Native event that caused the dragging to stop.", "jsdocTags": [] } ], "generics": [ { "name": "T", "default": "any" } ], "description": "Event emitted when the user stops dragging a draggable.", "jsdocTags": [], "rawComment": "/** Event emitted when the user stops dragging a draggable. */", "implements": [], "source": { "filePath": "/src/cdk/drag-drop/drag-events.ts", "startLine": 29, "endLine": 38 } }, { "name": "CdkDragHandle", "isAbstract": false, "entryType": "undecorated_class", "members": [ { "name": "constructor", "signatures": [ { "name": "constructor", "params": [ { "name": "args", "description": "", "type": "unknown[]", "isOptional": false, "isRestParam": true } ], "returnType": "CdkDragHandle", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "", "generics": [], "isNewType": false } ], "implementation": { "params": [], "isNewType": false, "returnType": "CdkDragHandle", "generics": [], "name": "constructor", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "" }, "entryType": "function", "description": "", "jsdocTags": [], "rawComment": "", "memberType": "method", "memberTags": [] }, { "name": "element", "type": "any", "memberType": "property", "memberTags": [], "description": "", "jsdocTags": [] }, { "name": "disabled", "type": "boolean", "memberType": "getter", "memberTags": [], "description": "Whether starting to drag through this handle is disabled.", "jsdocTags": [] }, { "name": "disabled", "type": "boolean", "memberType": "setter", "memberTags": [], "description": "", "jsdocTags": [] }, { "name": "ngAfterViewInit", "signatures": [ { "name": "ngAfterViewInit", "entryType": "function", "description": "", "generics": [], "isNewType": false, "jsdocTags": [], "params": [], "rawComment": "", "returnType": "void" } ], "implementation": { "params": [], "isNewType": false, "returnType": "void", "generics": [], "name": "ngAfterViewInit", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "" }, "entryType": "function", "description": "", "jsdocTags": [], "rawComment": "", "memberType": "method", "memberTags": [] }, { "name": "ngOnDestroy", "signatures": [ { "name": "ngOnDestroy", "entryType": "function", "description": "", "generics": [], "isNewType": false, "jsdocTags": [], "params": [], "rawComment": "", "returnType": "void" } ], "implementation": { "params": [], "isNewType": false, "returnType": "void", "generics": [], "name": "ngOnDestroy", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "" }, "entryType": "function", "description": "", "jsdocTags": [], "rawComment": "", "memberType": "method", "memberTags": [] } ], "generics": [], "description": "Handle that can be used to drag a CdkDrag instance.", "jsdocTags": [], "rawComment": "/** Handle that can be used to drag a CdkDrag instance. */", "implements": [ "AfterViewInit", "OnDestroy" ], "source": { "filePath": "/src/cdk/drag-drop/directives/drag-handle.ts", "startLine": 33, "endLine": 89 } }, { "name": "CDK_DRAG_CONFIG", "type": "any", "entryType": "constant", "rawComment": "/**\n * Injection token that can be used to configure the\n * behavior of the drag&drop-related components.\n */", "description": "Injection token that can be used to configure the\nbehavior of the drag&drop-related components.", "jsdocTags": [], "source": { "filePath": "src/cdk/drag-drop/directives/config.ts", "startLine": 28, "endLine": 28 } }, { "name": "DragDropConfig", "isAbstract": false, "entryType": "interface", "members": [ { "name": "lockAxis", "type": "DragAxis | undefined", "memberType": "property", "memberTags": [ "optional" ], "description": "", "jsdocTags": [] }, { "name": "dragStartDelay", "type": "DragStartDelay | undefined", "memberType": "property", "memberTags": [ "optional" ], "description": "", "jsdocTags": [] }, { "name": "constrainPosition", "type": "DragConstrainPosition | undefined", "memberType": "property", "memberTags": [ "optional" ], "description": "", "jsdocTags": [] }, { "name": "previewClass", "type": "string | string[] | undefined", "memberType": "property", "memberTags": [ "optional" ], "description": "", "jsdocTags": [] }, { "name": "boundaryElement", "type": "string | undefined", "memberType": "property", "memberTags": [ "optional" ], "description": "", "jsdocTags": [] }, { "name": "rootElementSelector", "type": "string | undefined", "memberType": "property", "memberTags": [ "optional" ], "description": "", "jsdocTags": [] }, { "name": "draggingDisabled", "type": "boolean | undefined", "memberType": "property", "memberTags": [ "optional" ], "description": "", "jsdocTags": [] }, { "name": "sortingDisabled", "type": "boolean | undefined", "memberType": "property", "memberTags": [ "optional" ], "description": "", "jsdocTags": [] }, { "name": "listAutoScrollDisabled", "type": "boolean | undefined", "memberType": "property", "memberTags": [ "optional" ], "description": "", "jsdocTags": [] }, { "name": "listOrientation", "type": "DropListOrientation | undefined", "memberType": "property", "memberTags": [ "optional" ], "description": "", "jsdocTags": [] }, { "name": "zIndex", "type": "number | undefined", "memberType": "property", "memberTags": [ "optional" ], "description": "", "jsdocTags": [] }, { "name": "previewContainer", "type": "\"global\" | \"parent\" | undefined", "memberType": "property", "memberTags": [ "optional" ], "description": "", "jsdocTags": [] }, { "name": "dragStartThreshold", "type": "number", "memberType": "property", "memberTags": [ "override" ], "description": "Minimum amount of pixels that the user should\ndrag, before the CDK initiates a drag sequence.", "jsdocTags": [] }, { "name": "pointerDirectionChangeThreshold", "type": "number", "memberType": "property", "memberTags": [ "override" ], "description": "Amount the pixels the user should drag before the CDK\nconsiders them to have changed the drag direction.", "jsdocTags": [] }, { "name": "parentDragRef", "type": "DragRef<any> | undefined", "memberType": "property", "memberTags": [ "optional", "override" ], "description": "Ref that the current drag item is nested in.", "jsdocTags": [] } ], "generics": [], "description": "Object that can be used to configure the drag\nitems and drop lists within a module or a component.", "jsdocTags": [], "rawComment": "/**\n * Object that can be used to configure the drag\n * items and drop lists within a module or a component.\n */", "extends": "Partial<DragRefConfig>", "implements": [], "source": { "filePath": "src/cdk/drag-drop/directives/config.ts", "startLine": 34, "endLine": 47 } }, { "name": "CdkDropList", "isAbstract": false, "entryType": "undecorated_class", "members": [ { "name": "constructor", "signatures": [ { "name": "constructor", "params": [ { "name": "args", "description": "", "type": "unknown[]", "isOptional": false, "isRestParam": true } ], "returnType": "CdkDropList", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "", "generics": [], "isNewType": false } ], "implementation": { "params": [], "isNewType": false, "returnType": "CdkDropList<T>", "generics": [], "name": "constructor", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "" }, "entryType": "function", "description": "", "jsdocTags": [], "rawComment": "", "memberType": "method", "memberTags": [] }, { "name": "element", "type": "any", "memberType": "property", "memberTags": [], "description": "", "jsdocTags": [] }, { "name": "connectedTo", "type": "string | CdkDropList<any> | (string | CdkDropList<any>)[]", "memberType": "property", "memberTags": [], "description": "Other draggable containers that this container is connected to and into which the\ncontainer's items can be transferred. Can either be references to other drop containers,\nor their unique IDs.", "jsdocTags": [] }, { "name": "data", "type": "T", "memberType": "property", "memberTags": [], "description": "Arbitrary data to attach to this container.", "jsdocTags": [] }, { "name": "orientation", "type": "DropListOrientation", "memberType": "property", "memberTags": [], "description": "Direction in which the list is oriented.", "jsdocTags": [] }, { "name": "id", "type": "string", "memberType": "property", "memberTags": [], "description": "Unique ID for the drop zone. Can be used as a reference\nin the `connectedTo` of another `CdkDropList`.", "jsdocTags": [] }, { "name": "lockAxis", "type": "DragAxis", "memberType": "property", "memberTags": [], "