@arcgis/core
Version:
ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API
38 lines (36 loc) • 1.92 kB
TypeScript
import type Input from "./Input.js";
/** @internal */
export interface DocumentInputProperties extends Partial<Pick<DocumentInput, "maxFileSize">> {}
/**
* The `DocumentInput` class defines a user interface for an input to which document files can be attached. This [AttachmentElement.input](https://developers.arcgis.com/javascript/latest/references/core/form/elements/AttachmentElement/#input) is used in [attachment elements](https://developers.arcgis.com/javascript/latest/references/core/form/elements/AttachmentElement/) that are set within a [feature layer's](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#formTemplate) or [FeatureForm's](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureForm/#formTemplate) `formTemplate`. This is displayed within the [Editor](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/) widget.
*
* > [!CAUTION]
* >
* > This class is not yet fully supported within the SDK and is not intended for use in development. Support will be added in an upcoming release.
*
* @internal
* @since 4.31
* @see [DocumentInput](https://developers.arcgis.com/javascript/latest/references/core/form/elements/inputs/attachments/DocumentInput/)
* @example
* // Creates a new DocumentInput for an attachment element within a form
* const documentInput = new DocumentInput({
* maxFileSize: 500
* });
*/
export default class DocumentInput extends Input {
/** @internal */
constructor(properties?: DocumentInputProperties);
/**
* Defines the maximum length of an attachment for this element in megabytes. If not specified, there is no maximum file size.
*
* @internal
*/
accessor maxFileSize: number | null | undefined;
/**
* The input type identifier. Valid value of this property is "document"
*
* @internal
* @since 5.0
*/
get type(): "document";
}