Class: NodeAnnotationBuilder<T>
The builder class to define the node metadata property.
Extends
Type Parameters
T
T
the property type.
Constructors
Constructor
new NodeAnnotationBuilder<
T>(editor):NodeAnnotationBuilder<T>
Creates a component property metadata builder.
Parameters
editor
string
the property editor type.
Returns
NodeAnnotationBuilder<T>
Overrides
Properties
annotation
annotation:
PreAnnotation
Partial metadata for a component property.
Inherited from
defaultEditor?
optionaldefaultEditor:NodeEditorType
The default editor.
insertPredicate()?
optionalinsertPredicate: (self,child) =>boolean
The function that checks whether a child component can be inserted into a parent component.
Parameters
self
child
Returns
boolean
options
options:
BuilderOptions
Options for building an annotation.
Inherited from
Accessors
array
Get Signature
get array():
ArrayBuilder<T[] |undefined>
Sets the property as a "array" property.
Returns
ArrayBuilder<T[] | undefined>
the instance of the metadata property builder.
Inherited from
dataBound
Get Signature
get dataBound():
this
Returns
this
the main property of the component that uses the form data as data (one-way data binding).
Inherited from
localize
Get Signature
get localize():
this
Returns
this
the component property that can be localized.
Inherited from
notLocalize
Get Signature
get notLocalize():
this
Returns
this
the non-localizable component property.
Inherited from
valued
Get Signature
get valued():
this
Returns
this
the main component property that is used as form data and for validation rules.
Inherited from
Methods
build()
build(
key):Annotation
Creates component property metadata for the form builder.
Parameters
key
string
the unique key of the component property.
Returns
the instance of the component property metadata for the form builder.
Overrides
calculable()
calculable(
calculable):NodeAnnotationBuilder<T>
Marks the component property as calculable.
Parameters
calculable
boolean
true if the property is calculable.
Returns
NodeAnnotationBuilder<T>
the modified instance of the builder.
Inherited from
clone()
clone():
this
Clones the instance of the builder.
Returns
this
the cloned instance of the builder.
Inherited from
getName()
protectedgetName(key):string
Returns the annotation name.
Parameters
key
string
the property name
Returns
string
the annotation name.
Inherited from
hideEditor()
hideEditor():
this
Hides the component property editor.
Returns
this
the modified instance of the builder.
Inherited from
hinted()
hinted(
hint):NodeAnnotationBuilder<T>
Adds the hint to the property name of the component.
Parameters
hint
ReactNode
the hint.
Returns
NodeAnnotationBuilder<T>
the modified instance of the builder.
Inherited from
named()
named(
name):NodeAnnotationBuilder<T>
Specifies the name of the component property.
Parameters
name
string
the property name.
Returns
NodeAnnotationBuilder<T>
the modified instance of the builder.
Inherited from
oneOf()
oneOf<
U>(...values):OneOfBuilder<U>
Sets the property as a "single select" property.
Type Parameters
U
U extends number | string
Parameters
values
...U[]
the possible values for the property.
Returns
OneOfBuilder<U>
the instance of the metadata property builder.
Inherited from
setup()
setup(
options):this
Modifies the component property metadata builder with custom options.
Parameters
options
the custom options.
Returns
this
the modified instance of the builder.
Inherited from
someOf()
someOf<
U>(...values):SomeOfBuilder<U>
Sets the property as a "multiple select" property.
Type Parameters
U
U extends number | string
Parameters
values
...U[]
the possible values for the property.
Returns
the instance of the metadata property builder.
Inherited from
typed()
typed<
T>(type):TypedBuilder<SchemaTypeMap[T] |undefined>
Sets the field type for the component property.
Type Parameters
T
T extends keyof SchemaTypeMap
Parameters
type
T
the field type.
Returns
TypedBuilder<SchemaTypeMap[T] | undefined>
the instance of the metadata property builder.
Inherited from
uncontrolledValue()
uncontrolledValue(
uncontrolledValue):NodeAnnotationBuilder<T>
Sets the value for the property that prevents uncontrolled state.
Parameters
uncontrolledValue
unknown
the value for the uncontrolled state.
Returns
NodeAnnotationBuilder<T>
the modified instance of the builder.
Inherited from
AnnotationBuilder.uncontrolledValue
withDefaultEditor()
withDefaultEditor(
defaultEditor):NodeAnnotationBuilder<T>
Specifies the default editor for the property.
Parameters
defaultEditor
the default editor.
Returns
NodeAnnotationBuilder<T>
the modified instance of the builder.
withEditorProps()
withEditorProps(
props):this
Sets custom properties for the component's property editor.
Parameters
props
any
the custom properties
Returns
this
the modified instance of the builder.
Inherited from
AnnotationBuilder.withEditorProps
withInsertRestriction()
withInsertRestriction(
predicate?):NodeAnnotationBuilder<T>
Specifies a function that checks whether a child component can be inserted into a parent component.
Parameters
predicate?
(self, child) => boolean
the function that returns a boolean value.
Returns
NodeAnnotationBuilder<T>
the modified instance of the builder.
withSlotConditionBuilder()
withSlotConditionBuilder(
slotConditionBuilder):this
Specifies a function that will create conditions that check if a child component can be bound to a parent slot.
Parameters
slotConditionBuilder
(props) => string
the function that returns a string containing the source code of the function to bind child components.
Returns
this
the instance of the metadata property builder.
create()
staticcreate<T>(editor):AnnotationBuilder<T>
Creates a component property metadata builder.
Type Parameters
T
T
the property type.
Parameters
editor
string
the property editor type.
Returns
the component property metadata builder.