Class: AnnotationBuilder<T>
The builder class to define the metadata property of the form builder component.
Extends
BaseBuilder<T>
Extended by
Type Parameters
• T
the property type.
Constructors
new AnnotationBuilder()
new AnnotationBuilder<
T>(editor):AnnotationBuilder<T>
Creates a component property metadata builder.
Parameters
• editor: string
the property editor type.
Returns
Overrides
Properties
annotation
annotation:
PreAnnotation
Partial metadata for a component property.
Inherited from
options
options:
BuilderOptions
Options for building an annotation.
Inherited from
Accessors
array
Get Signature
get array():
ArrayBuilder<undefined|T[]>
Sets the property as a "array" property.
Returns
ArrayBuilder<undefined | T[]>
the instance of the metadata property builder.
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.
Inherited from
calculable()
calculable(
calculable):AnnotationBuilder<T>
Marks the component property as calculable.
Parameters
• calculable: boolean
true if the property is calculable.
Returns
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):AnnotationBuilder<T>
Adds the hint to the property name of the component.
Parameters
• hint: ReactNode
the hint.
Returns
the modified instance of the builder.
Inherited from
named()
named(
name):AnnotationBuilder<T>
Specifies the name of the component property.
Parameters
• name: string
the property name.
Returns
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 extends string | number
Parameters
• ...values: U[]
the possible values for the property.
Returns
OneOfBuilder<U>
the instance of the metadata property builder.
setup()
setup(
options):this
Modifies the component property metadata builder with custom options.
Parameters
• options: Partial<Partial<Omit<Annotation, "key">> & Pick<Annotation, "editor"> & BuilderOptions>
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 extends string | number
Parameters
• ...values: U[]
the possible values for the property.
Returns
the instance of the metadata property builder.
typed()
typed<
T>(type):TypedBuilder<undefined|SchemaTypeMap[T]>
Sets the field type for the component property.
Type Parameters
• T extends keyof SchemaTypeMap
Parameters
• type: T
the field type.
Returns
TypedBuilder<undefined | SchemaTypeMap[T]>
the instance of the metadata property 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
create()
staticcreate<T>(editor):AnnotationBuilder<T>
Creates a component property metadata builder.
Type Parameters
• T
the property type.
Parameters
• editor: string
the property editor type.
Returns
the component property metadata builder.