@syncfusion/ej2-filemanager 29.2.4 → 30.1.37

package/dist/ts/file-manager/models/ajax-settings-model.d.ts

@@ -0,0 +1,36 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+
+/**
+ * Interface for a class AjaxSettings
+ */
+export interface AjaxSettingsModel {
+
+    /**
+     * Specifies URL to download the files from server.
+     *
+     * @default null
+     */
+    downloadUrl?: string;
+
+    /**
+     * Specifies URL to get the images from server.
+     *
+     * @default null
+     */
+    getImageUrl?: string;
+
+    /**
+     * Specifies URL to upload the files to server.
+     *
+     * @default null
+     */
+    uploadUrl?: string;
+
+    /**
+     * Specifies URL to read the files from server.
+     *
+     * @default null
+     */
+    url?: string;
+
+}

package/dist/ts/file-manager/models/ajax-settings.d.ts

@@ -0,0 +1,30 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+/**
+ * Specifies the Ajax settings of the File Manager.
+ */
+export declare class AjaxSettings extends ChildProperty<AjaxSettings> {
+    /**
+     * Specifies URL to download the files from server.
+     *
+     * @default null
+     */
+    downloadUrl: string;
+    /**
+     * Specifies URL to get the images from server.
+     *
+     * @default null
+     */
+    getImageUrl: string;
+    /**
+     * Specifies URL to upload the files to server.
+     *
+     * @default null
+     */
+    uploadUrl: string;
+    /**
+     * Specifies URL to read the files from server.
+     *
+     * @default null
+     */
+    url: string;
+}

package/dist/ts/file-manager/models/ajax-settings.ts

@@ -0,0 +1,39 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+
+/**
+ * Specifies the Ajax settings of the File Manager.
+ */
+export class AjaxSettings extends ChildProperty<AjaxSettings> {
+    /**
+     * Specifies URL to download the files from server.
+     *
+     * @default null
+     */
+    @Property(null)
+    public downloadUrl: string;
+
+    /**
+     * Specifies URL to get the images from server.
+     *
+     * @default null
+     */
+    @Property(null)
+    public getImageUrl: string;
+
+    /**
+     * Specifies URL to upload the files to server.
+     *
+     * @default null
+     */
+    @Property(null)
+    public uploadUrl: string;
+
+    /**
+     * Specifies URL to read the files from server.
+     *
+     * @default null
+     */
+    @Property(null)
+    public url: string;
+}
+

package/dist/ts/file-manager/models/column-model.d.ts

@@ -0,0 +1,155 @@
+import { Property, ChildProperty, NumberFormatOptions, DateFormatOptions } from '@syncfusion/ej2-base';import { SortComparer } from '../base/interface';
+import {TextAlign} from "./column";
+
+/**
+ * Interface for a class Column
+ */
+export interface ColumnModel {
+
+    /**
+     * Defines the field name of column which is mapped with mapping name of DataSource.
+     * The bounded columns can be sort, filter and group etc.,
+     * The `field` name must be a valid JavaScript identifier,
+     * the first character must be an alphabet and should not contain spaces and special characters.
+     *
+     * @default ''
+     */
+    field?: string;
+
+    /**
+     * Defines the header text of column which is used to display in column header.
+     * If `headerText` is not defined, then field name value will be assigned to header text.
+     *
+     * @default ''
+     */
+    headerText?: string;
+
+    /**
+     * Defines the width of the column in pixels or percentage.
+     *
+     * @default ''
+     */
+    width?: string | number;
+
+    /**
+     * Defines the minimum width of the column in pixels or percentage.
+     *
+     * @default ''
+     */
+    minWidth?: string | number;
+
+    /**
+     * Defines the maximum width of the column in pixel or percentage, which will restrict resizing beyond this pixel or percentage.
+     *
+     * @default ''
+     */
+    maxWidth?: string | number;
+
+    /**
+     * Defines the alignment of the column in both header and content cells.
+     *
+     * @default Left
+     */
+    textAlign?: TextAlign;
+
+    /**
+     * Define the alignment of column header which is used to align the text of column header.
+     *
+     * @default null
+     */
+    headerTextAlign?: TextAlign;
+
+    /**
+     * Defines the data type of the column.
+     *
+     * @default null
+     */
+    type?: string;
+
+    /**
+     * It is used to change display value with the given format and does not affect the original data.
+     * Gets the format from the user which can be standard or custom
+     * [`number`](../../common/internationalization/#manipulating-numbers)
+     * and [`date`](../../common/internationalization/#manipulating-datetime) formats.
+     *
+     * @default null
+     * @aspType string
+     */
+    format?: string | NumberFormatOptions | DateFormatOptions;
+
+    /**
+     * Defines the column template that renders customized element in each cell of the column.
+     * It accepts either [template string](https://ej2.syncfusion.com/documentation/common/template-engine/) or HTML element ID.
+     *
+     * @default null
+     * @aspType string
+     */
+    template?: string | Function;
+
+    /**
+     * Defines the custom sort comparer function.
+     * The sort comparer function has the same functionality like
+     * [`Array.sort`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) sort comparer.
+     *
+     * @default null
+     * @aspType string
+     */
+    sortComparer?: SortComparer | string;
+
+    /**
+     * Defines the column template as string or HTML element ID which is used to add customized element in the column header.
+     *
+     * @default null
+     * @aspType string
+     */
+    headerTemplate?: string | Function;
+
+    /**
+     * If `allowSorting` set to false, then it disables sorting option of a particular column.
+     * By default all columns are sortable.
+     *
+     * @default true
+     */
+    allowSorting?: boolean;
+
+    /**
+     * If `allowResizing` set to false, it disables resize option of a particular column.
+     *
+     * @default true
+     */
+    allowResizing?: boolean;
+
+    /**
+     * The CSS styles and attributes of the content cells of a particular column can be customized.
+     *
+     * @default null
+     */
+    customAttributes?: { [x: string]: Object };
+
+    /**
+     * Column visibility can change based on [`Media Queries`](http://cssmediaqueries.com/what-are-css-media-queries.html).
+     * `hideAtMedia` accepts only valid Media Queries.
+     *
+     * @default ''
+     */
+    hideAtMedia?: string;
+
+    /**
+     * It is used to change display value with the given format and does not affect the original data.
+     * Gets the format from the user which can be standard or custom
+     * [`number`](../../common/internationalization/#manipulating-numbers)
+     * and [`date`](../../common/internationalization/#manipulating-datetime) formats.
+     *
+     * @default null
+     */
+    customFormat?: { [x: string]: Object };
+
+    /**
+     * If `isPrimaryKey` is set to true, considers this column as the primary key constraint.
+     *
+     * @deprecated
+     * @default false
+     */
+    isPrimaryKey?: boolean;
+
+}

package/dist/ts/file-manager/models/column.d.ts

@@ -0,0 +1,179 @@
+import { ChildProperty, NumberFormatOptions, DateFormatOptions } from '@syncfusion/ej2-base';
+import { SortComparer } from '../base/interface';
+/**
+ * Defines alignments of text, they are
+ * * Left
+ * * Right
+ * * Center
+ * * Justify
+ */
+export declare type TextAlign = 
+/**  Defines Left alignment */
+'Left' | 
+/**  Defines Right alignment */
+'Right' | 
+/**  Defines Center alignment */
+'Center' | 
+/**  Defines Justify alignment */
+'Justify';
+/**
+ * Defines the cell content's overflow mode. The available modes are
+ * * `Clip` -  Truncates the cell content when it overflows its area.
+ * * `Ellipsis` -  Displays ellipsis when the cell content overflows its area.
+ * * `EllipsisWithTooltip` - Displays ellipsis when the cell content overflows its area
+ * also it will display tooltip while hover on ellipsis applied cell.
+ */
+export declare type ClipMode = 
+/**  Truncates the cell content when it overflows its area */
+'Clip' | 
+/** Displays ellipsis when the cell content overflows its area */
+'Ellipsis' | 
+/** Displays ellipsis when the cell content overflows its area also it will display tooltip while hover on ellipsis applied cell. */
+'EllipsisWithTooltip';
+/**
+ * Interface for a class Column
+ */
+export declare class Column extends ChildProperty<Column> {
+    /**
+     * Defines the field name of column which is mapped with mapping name of DataSource.
+     * The bounded columns can be sort, filter and group etc.,
+     * The `field` name must be a valid JavaScript identifier,
+     * the first character must be an alphabet and should not contain spaces and special characters.
+     *
+     * @default ''
+     */
+    field: string;
+    /**
+     * Defines the header text of column which is used to display in column header.
+     * If `headerText` is not defined, then field name value will be assigned to header text.
+     *
+     * @default ''
+     */
+    headerText: string;
+    /**
+     * Defines the width of the column in pixels or percentage.
+     *
+     * @default ''
+     */
+    width: string | number;
+    /**
+     * Defines the minimum width of the column in pixels or percentage.
+     *
+     * @default ''
+     */
+    minWidth: string | number;
+    /**
+     * Defines the maximum width of the column in pixel or percentage, which will restrict resizing beyond this pixel or percentage.
+     *
+     * @default ''
+     */
+    maxWidth: string | number;
+    /**
+     * Defines the alignment of the column in both header and content cells.
+     *
+     * @default Left
+     */
+    textAlign: TextAlign;
+    /**
+     * Defines the cell content's overflow mode. The available modes are
+     * * `Clip` -  Truncates the cell content when it overflows its area.
+     * * `Ellipsis` -  Displays ellipsis when the cell content overflows its area.
+     * * `EllipsisWithTooltip` - Displays ellipsis when the cell content overflows its area
+     * also it will display tooltip while hover on ellipsis applied cell.
+     *
+     * @default Ellipsis
+     */
+    clipMode: ClipMode;
+    /**
+     * Define the alignment of column header which is used to align the text of column header.
+     *
+     * @default null
+     */
+    headerTextAlign: TextAlign;
+    /**
+     * Defines the data type of the column.
+     *
+     * @default null
+     */
+    type: string;
+    /**
+     * It is used to change display value with the given format and does not affect the original data.
+     * Gets the format from the user which can be standard or custom
+     * [`number`](../../common/internationalization/#manipulating-numbers)
+     * and [`date`](../../common/internationalization/#manipulating-datetime) formats.
+     *
+     * @default null
+     * @aspType string
+     */
+    format: string | NumberFormatOptions | DateFormatOptions;
+    /**
+     * Defines the column template that renders customized element in each cell of the column.
+     * It accepts either [template string](https://ej2.syncfusion.com/documentation/common/template-engine/) or HTML element ID.
+     *
+     * @default null
+     * @aspType string
+     */
+    template: string | Function;
+    /**
+     * Defines the custom sort comparer function.
+     * The sort comparer function has the same functionality like
+     * [`Array.sort`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) sort comparer.
+     *
+     * @default null
+     * @aspType string
+     */
+    sortComparer: SortComparer | string;
+    /**
+     * Defines the column template as string or HTML element ID which is used to add customized element in the column header.
+     *
+     * @default null
+     * @aspType string
+     */
+    headerTemplate: string | Function;
+    /**
+     * If `allowSorting` set to false, then it disables sorting option of a particular column.
+     * By default all columns are sortable.
+     *
+     * @default true
+     */
+    allowSorting: boolean;
+    /**
+     * If `allowResizing` set to false, it disables resize option of a particular column.
+     *
+     * @default true
+     */
+    allowResizing: boolean;
+    /**
+     * The CSS styles and attributes of the content cells of a particular column can be customized.
+     *
+     * @default null
+     */
+    customAttributes: {
+        [x: string]: Object;
+    };
+    /**
+     * Column visibility can change based on [`Media Queries`](http://cssmediaqueries.com/what-are-css-media-queries.html).
+     * `hideAtMedia` accepts only valid Media Queries.
+     *
+     * @default ''
+     */
+    hideAtMedia: string;
+    /**
+     * It is used to change display value with the given format and does not affect the original data.
+     * Gets the format from the user which can be standard or custom
+     * [`number`](../../common/internationalization/#manipulating-numbers)
+     * and [`date`](../../common/internationalization/#manipulating-datetime) formats.
+     *
+     * @default null
+     */
+    customFormat: {
+        [x: string]: Object;
+    };
+    /**
+     * If `isPrimaryKey` is set to true, considers this column as the primary key constraint.
+     *
+     * @deprecated
+     * @default false
+     */
+    isPrimaryKey: boolean;
+}

package/dist/ts/file-manager/models/column.ts

@@ -0,0 +1,216 @@
+import { Property, ChildProperty, NumberFormatOptions, DateFormatOptions } from '@syncfusion/ej2-base';
+import { SortComparer } from '../base/interface';
+
+/**
+ * Defines alignments of text, they are
+ * * Left
+ * * Right
+ * * Center
+ * * Justify
+ */
+export type TextAlign =
+    /**  Defines Left alignment */
+    'Left' |
+    /**  Defines Right alignment */
+    'Right' |
+    /**  Defines Center alignment */
+    'Center' |
+    /**  Defines Justify alignment */
+    'Justify';
+
+/**
+ * Defines the cell content's overflow mode. The available modes are
+ * * `Clip` -  Truncates the cell content when it overflows its area.
+ * * `Ellipsis` -  Displays ellipsis when the cell content overflows its area.
+ * * `EllipsisWithTooltip` - Displays ellipsis when the cell content overflows its area
+ * also it will display tooltip while hover on ellipsis applied cell.
+ */
+export type ClipMode =
+    /**  Truncates the cell content when it overflows its area */
+    'Clip' |
+    /** Displays ellipsis when the cell content overflows its area */
+    'Ellipsis' |
+    /** Displays ellipsis when the cell content overflows its area also it will display tooltip while hover on ellipsis applied cell. */
+    'EllipsisWithTooltip';
+
+/**
+ * Interface for a class Column
+ */
+/* istanbul ignore next */
+export class Column extends ChildProperty<Column> {
+
+    /**
+     * Defines the field name of column which is mapped with mapping name of DataSource.
+     * The bounded columns can be sort, filter and group etc.,
+     * The `field` name must be a valid JavaScript identifier,
+     * the first character must be an alphabet and should not contain spaces and special characters.
+     *
+     * @default ''
+     */
+    @Property('')
+    public field: string;
+
+    /**
+     * Defines the header text of column which is used to display in column header.
+     * If `headerText` is not defined, then field name value will be assigned to header text.
+     *
+     * @default ''
+     */
+    @Property('')
+    public headerText: string;
+
+    /**
+     * Defines the width of the column in pixels or percentage.
+     *
+     * @default ''
+     */
+    @Property('')
+    public width: string | number;
+
+    /**
+     * Defines the minimum width of the column in pixels or percentage.
+     *
+     * @default ''
+     */
+    @Property('')
+    public minWidth: string | number;
+
+    /**
+     * Defines the maximum width of the column in pixel or percentage, which will restrict resizing beyond this pixel or percentage.
+     *
+     * @default ''
+     */
+    @Property('')
+    public maxWidth: string | number;
+
+    /**
+     * Defines the alignment of the column in both header and content cells.
+     *
+     * @default Left
+     */
+    @Property('Left')
+    public textAlign: TextAlign;
+
+    /**
+     * Defines the cell content's overflow mode. The available modes are
+     * * `Clip` -  Truncates the cell content when it overflows its area.
+     * * `Ellipsis` -  Displays ellipsis when the cell content overflows its area.
+     * * `EllipsisWithTooltip` - Displays ellipsis when the cell content overflows its area
+     * also it will display tooltip while hover on ellipsis applied cell.
+     *
+     * @default Ellipsis
+     */
+    public clipMode: ClipMode;
+
+    /**
+     * Define the alignment of column header which is used to align the text of column header.
+     *
+     * @default null
+     */
+    @Property(null)
+    public headerTextAlign: TextAlign;
+
+    /**
+     * Defines the data type of the column.
+     *
+     * @default null
+     */
+    @Property(null)
+    public type: string;
+
+    /**
+     * It is used to change display value with the given format and does not affect the original data.
+     * Gets the format from the user which can be standard or custom
+     * [`number`](../../common/internationalization/#manipulating-numbers)
+     * and [`date`](../../common/internationalization/#manipulating-datetime) formats.
+     *
+     * @default null
+     * @aspType string
+     */
+    @Property(null)
+    public format: string | NumberFormatOptions | DateFormatOptions;
+
+    /**
+     * Defines the column template that renders customized element in each cell of the column.
+     * It accepts either [template string](https://ej2.syncfusion.com/documentation/common/template-engine/) or HTML element ID.
+     *
+     * @default null
+     * @aspType string
+     */
+    @Property(null)
+    public template: string | Function;
+
+    /**
+     * Defines the custom sort comparer function.
+     * The sort comparer function has the same functionality like
+     * [`Array.sort`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) sort comparer.
+     *
+     * @default null
+     * @aspType string
+     */
+    @Property(null)
+    public sortComparer: SortComparer | string;
+
+    /**
+     * Defines the column template as string or HTML element ID which is used to add customized element in the column header.
+     *
+     * @default null
+     * @aspType string
+     */
+    @Property(null)
+    public headerTemplate: string | Function;
+
+    /**
+     * If `allowSorting` set to false, then it disables sorting option of a particular column.
+     * By default all columns are sortable.
+     *
+     * @default true
+     */
+    @Property(true)
+    public allowSorting: boolean;
+
+    /**
+     * If `allowResizing` set to false, it disables resize option of a particular column.
+     *
+     * @default true
+     */
+    @Property(true)
+    public allowResizing: boolean;
+
+    /**
+     * The CSS styles and attributes of the content cells of a particular column can be customized.
+     *
+     * @default null
+     */
+    @Property(null)
+    public customAttributes: { [x: string]: Object };
+
+    /**
+     * Column visibility can change based on [`Media Queries`](http://cssmediaqueries.com/what-are-css-media-queries.html).
+     * `hideAtMedia` accepts only valid Media Queries.
+     *
+     * @default ''
+     */
+    @Property('')
+    public hideAtMedia: string;
+
+    /**
+     * It is used to change display value with the given format and does not affect the original data.
+     * Gets the format from the user which can be standard or custom
+     * [`number`](../../common/internationalization/#manipulating-numbers)
+     * and [`date`](../../common/internationalization/#manipulating-datetime) formats.
+     *
+     * @default null
+     */
+    @Property(null)
+    public customFormat: { [x: string]: Object };
+
+    /**
+     * If `isPrimaryKey` is set to true, considers this column as the primary key constraint.
+     *
+     * @deprecated
+     * @default false
+     */
+    @Property(false)
+    public isPrimaryKey: boolean;
+}

package/dist/ts/file-manager/models/contextMenu-settings-model.d.ts

@@ -0,0 +1,36 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+
+/**
+ * Interface for a class ContextMenuSettings
+ */
+export interface ContextMenuSettingsModel {
+
+    /**
+     * Specifies the array of string or object that is used to configure file items.
+     *
+     * @default fileItems
+     */
+    file?: string[];
+
+    /**
+     * An array of string or object that is used to configure folder items.
+     *
+     * @default folderItems
+     */
+    folder?: string[];
+
+    /**
+     * An array of string or object that is used to configure layout items.
+     *
+     * @default layoutItems
+     */
+    layout?: string[];
+
+    /**
+     * Enables or disables the ContextMenu.
+     *
+     * @default true
+     */
+    visible?: boolean;
+
+}