Class: ProfileClassInput
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:61
Represents an input for a profile class.
Constructors
Constructor
new ProfileClassInput(
id,label,type,description?,example?,options?,required?,hints?):ProfileClassInput
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:83
Parameters
id
string
label
string
type
string
description?
string
example?
string
options?
string[] = []
required?
boolean
hints?
Returns
ProfileClassInput
Properties
description?
readonlyoptionaldescription:string
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:77
example?
readonlyoptionalexample:string
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:78
hints?
optionalhints:object
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:81
Index Signature
[key: string]: object
id
readonlyid:string
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:74
Creates an instance of ProfileClassInput.
Param
The ID of the input.
Param
The label of the input.
Param
The type of the input.
Param
The description of the input.
Param
An example of the input.
Param
The options of the input.
Param
Whether the input is required.
Param
Hints for certain inputs
label
readonlylabel:string
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:75
options?
readonlyoptionaloptions:string[]
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:79
required?
optionalrequired:boolean
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:80
type
readonlytype:string
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:76
Methods
getDescription()
getDescription():
undefined|string
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:117
Retrieves the description of the property input.
Returns
undefined | string
The description of the property input.
getExample()
getExample():
undefined|string
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:126
Retrieves the example of the property input.
Returns
undefined | string
The example of the property input.
getHint()
getHint(
input,hintType):any
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:174
Retrieves a hint based on the provided input and hint type.
Parameters
input
string
The key used to look up the hint.
hintType
The specific type of hint to retrieve.
Returns
any
An object representing the hint, or undefined if no hint is found.
getId()
getId():
string
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:108
Retrieves the unique identifier of the property input.
Returns
string
The identifier of the property input.
getLabel()
getLabel():
string
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:135
Retrieves the label of the property input.
Returns
string
The label of the property input.
getOptions()
getOptions():
string[]
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:153
Retrieves the options of the input.
Returns
string[]
The options of the property input.
getType()
getType():
string
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:144
Retrieves the type of the property input.
Returns
string
The type of the property input.
hasHints()
hasHints(
input):boolean
Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:163
Determines whether hints exist for the given input key.
Parameters
input
string
The key to check for associated hints.
Returns
boolean
true if hints exist for the specified input key; otherwise, false.