Interface: AnnotationEditorProps
Props for the AnnotationEditor component.
Extends
Properties
annotation
annotation:
Annotation
Annotation editor annotation.
componentData
componentData:
ComponentData
The component data.
disableCompute
disableCompute: () =>
void
Disables the ability to make the property computable.
Returns
void
Inherited from
CalculableEditorProps.disableCompute
displayedSection?
optionaldisplayedSection?:Section
The displayed section.
getComputeCode
getComputeCode: <
T>(type,params?) =>string
Returns the code of the computed property.
Type Parameters
T
T extends ComponentPropertyComputeType
the component property value type.
Parameters
type
T
the component property value type.
params?
the parameters of the compute code.
Returns
string
the code of the computed property.
Inherited from
CalculableEditorProps.getComputeCode
getComputeType
getComputeType: () =>
ComponentPropertyComputeType|undefined
Returns the type of calculation for the property.
Returns
ComponentPropertyComputeType | undefined
Inherited from
CalculableEditorProps.getComputeType
hasComputeCode
hasComputeCode: (
type) =>boolean
Returns true if the property has a compute code for the specified type, false otherwise.
Parameters
type
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) =>void
Annotation editor onChange handler.
Parameters
value
any
Returns
void
onClean
onClean: () =>
void
Annotation editor onClean handler.
Returns
void
setComputeCode
setComputeCode: <
T>(value,type,params?) =>void
Sets the computed property code.
Type Parameters
T
T extends ComponentPropertyComputeType
the component property value type.
Parameters
value
string
the code of computed property.
type
T
the component property value type.
params?
the parameters of the compute code.
Returns
void
Inherited from
CalculableEditorProps.setComputeCode
showError?
optionalshowError?: (message?) =>void
Displays an error message to the user.
Parameters
message?
string
Returns
void
value
value:
any
Annotation editor value.