File size: 4,078 Bytes
71174bc | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 | import { ISphereOrBox } from "@/UI/Navigation/TreeView/TreeInterfaces";
import {
IProtCmpdTreeNodePair,
MoleculeInput,
} from "../MoleculeInputParams/MoleculeInput";
import { FileInfo } from "@/FileSystem/FileInfo";
import { MoleculeTypeFilter } from "../FormSelectMolecule/FormSelectMoleculeInterfaces";
export enum UserArgType {
Text,
TextArea,
Number,
Color,
Select,
Range,
Group,
MoleculeInputParams,
Checkbox,
Vector3D,
Alert,
SelectRegion,
ListSelect,
SelectMolecule,
}
export interface IUserArgOption {
description: string;
val: any;
disabled?: boolean;
}
interface IUserArg {
id: string;
// Children interfaces may redefine, but all should have val.
val: any;
// `type` inferred if not given, but in some cases must specify (e.g.,
// UserArgType.Number and UserArgType.Range both deal with numbers)
type?: UserArgType;
label?: string;
// Action button not enabled unless this passes.
validateFunc?: (val: any) => boolean;
// Adds a warning text to the Description. Doesn't prevent action button.
warningFunc?: (val: any) => string;
enabled?: boolean;
// Description appears below in smaller font. TODO: Not implemented
// everywhere. Just as needed.
description?: string;
}
export interface IUserArgText extends IUserArg {
val: string;
placeHolder?: string;
delayBetweenChangesDetected?: number;
filterFunc?: (val: any) => any;
}
export interface IUserArgTextArea extends IUserArg {
val: string;
placeHolder?: string;
filterFunc?: (val: any) => any;
}
export interface IUserArgColor extends IUserArg {
val: string;
}
export interface IUserArgNumber extends IUserArg {
val: number;
placeHolder?: string;
filterFunc?: (val: any) => any;
}
export interface IUserArgCheckbox extends IUserArg {
val: boolean;
}
export interface IUserArgRange extends IUserArgNumber {
min: number;
max: number;
step: number;
}
export interface IUserArgVector3D extends IUserArg {
val: [number, number, number];
}
export interface IUserArgSelect extends IUserArg {
val: string;
options: (string | IUserArgOption)[];
}
export interface IUserArgGroup extends IUserArg {
// Use label as title.
val: UserArg[];
startOpened?: boolean;
}
export interface IUserArgMoleculeInputParams extends IUserArg {
val: MoleculeInput | FileInfo[] | IProtCmpdTreeNodePair[];
}
export interface IUserArgAlert extends IUserArg {
// Use val (not label!) as message.
alertType: string; // warning, info, etc.
val: string; // Required
}
export interface IUserSelectRegion extends IUserArg {
val: ISphereOrBox | null;
regionName?: string;
}
/**
* Interface for the ListSelect user argument.
* This allows for a text input of a list (comma or space separated)
* and an optional dropdown to append items to that list.
*/
export interface IUserArgListSelect extends IUserArg {
// The current value of the list, as an array of strings or numbers. */
val: string[] | number[];
// Specifies whether the input items are 'text' or 'number'. If 'number',
// ranges like "1-5" are supported. */
inputType: "text" | "number";
// Optional array of predefined options to append from a dropdown. */
options?: (string | IUserArgOption)[];
// Placeholder text for the text input field. */
placeHolder?: string;
// Delay in ms after input before triggering change detection. */
delayBetweenChangesDetected?: number;
}
export interface IUserArgSelectMolecule extends IUserArg {
val: string; // Will hold the ID of the selected molecule
filterType?: MoleculeTypeFilter;
}
export type UserArg =
| IUserArgText
| IUserArgNumber
| IUserArgSelect
| IUserArgRange
| IUserArgTextArea
| IUserArgGroup
| IUserArgMoleculeInputParams
| IUserArgColor
| IUserArgCheckbox
| IUserArgVector3D
| IUserArgAlert
| IUserSelectRegion
| IUserArgListSelect
| IUserArgSelectMolecule;
|