Interface: AnnotationEditorProps
@react-form-builder/designer.AnnotationEditorProps
Props for the AnnotationEditor component.
Hierarchy
↳
AnnotationEditorProps
Properties
annotation
• annotation: Annotation
Annotation editor annotation.
componentData
• componentData: ComponentData
The component data.
disableCompute
• disableCompute: () => void
Type declaration
▸ (): void
Disables the ability to make the property computable.
Returns
void
Inherited from
CalculableEditorProps.disableCompute
getComputeCode
• getComputeCode: <T>(type: T, params?: ComputeTypeParams<T>) => string
Type declaration
▸ <T>(type, params?): string
Returns the code of the computed property.
Type parameters
| Name | Type | Description |
|---|---|---|
T | extends ComponentPropertyComputeType | the component property value type. |
Parameters
| Name | Type | Description |
|---|---|---|
type | T | the component property value type. |
params? | ComputeTypeParams<T> | the parameters of the compute code. |
Returns
string
the code of the computed property.
Inherited from
CalculableEditorProps.getComputeCode
getComputeType
• getComputeType: () => undefined | ComponentPropertyComputeType
Type declaration
▸ (): undefined | ComponentPropertyComputeType
Returns the type of calculation for the property.
Returns
undefined | ComponentPropertyComputeType
Inherited from
CalculableEditorProps.getComputeType
hasComputeCode
• hasComputeCode: (type: ComponentPropertyComputeType) => boolean
Type declaration
▸ (type): boolean
Returns true if the property has a compute code for the specified type, false otherwise.
Parameters
| Name | Type | Description |
|---|---|---|
type | ComponentPropertyComputeType | the compute type. |
Returns
boolean
true if the property has a compute code for the specified type, false otherwise.
Inherited from
CalculableEditorProps.hasComputeCode
onChange
• onChange: (value: any) => void
Type declaration
▸ (value): void
Annotation editor onChange handler.
Parameters
| Name | Type |
|---|---|
value | any |
Returns
void
onClean
• onClean: () => void
Type declaration
▸ (): void
Annotation editor onClean handler.
Returns
void
setComputeCode
• setComputeCode: <T>(value: string, type: T, params?: ComputeTypeParams<T>) => void
Type declaration
▸ <T>(value, type, params?): void
Sets the computed property code.
Type parameters
| Name | Type | Description |
|---|---|---|
T | extends ComponentPropertyComputeType | the component property value type. |
Parameters
| Name | Type | Description |
|---|---|---|
value | string | the code of computed property. |
type | T | the component property value type. |
params? | ComputeTypeParams<T> | the parameters of the compute code. |
Returns
void
Inherited from
CalculableEditorProps.setComputeCode
showError
• Optional showError: (message?: string) => void
Type declaration
▸ (message?): void
Displays an error message to the user.
Parameters
| Name | Type |
|---|---|
message? | string |
Returns
void
value
• value: any
Annotation editor value.