Constructor
# new ComponentDefinition(propsopt)
Default constructor.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
props |
object
|
<optional> |
Object that contains all properties to set. |
type |
string
|
<optional> |
The type of the associated component. |
icon |
string
|
<optional> |
The icon's name of this type of component. |
model |
string
|
<optional> |
Name of SVG template to render this type of component. |
displayName |
string
|
<optional> |
Display name of the component. |
description |
string
|
<optional> |
Explanation of the component. |
categories |
Array.<string>
|
<optional> |
Categories of the component. |
tags |
Array.<string>
|
<optional> |
Tags of the component. |
url |
string
|
<optional> |
URL of the documentation of the component. |
parentTypes |
Array.<string>
|
<optional> |
The list of types that can be the parent. |
childrenTypes |
Array.<string>
|
<optional> |
The list of types that can be the children. |
definedAttributes |
Array.<ComponentAttributeDefinition>
|
<optional> |
Defined attributes for this type. |
isContainer |
boolean
|
<optional> |
Boolean means if this type can be a parent. instantiated components. |
displayType |
string
|
<optional> |
Use the given displayType to override the component's rendering. Allowed values: workflow|null. |
workflowDirection |
string
|
<optional> |
Workflow direction, can be horizontal or vertical. Default value is horizontal. |
linkModel |
string
|
<optional> |
Name of SVG template to render the link of this component, only used in case of workflow. |
defaultWidth |
number
|
<optional> |
Default width that will be set on creation. |
defaultHeight |
number
|
<optional> |
Default height that will be set on creation. |
minWidth |
number
|
<optional> |
Minimum width of the component. |
minHeight |
number
|
<optional> |
Minimum height of the component. |
reservedWidth |
number
|
<optional> |
Width reserved in the component for display, only use for container. |
reservedHeight |
number
|
<optional> |
Height reserved in the component for display, only use for container. |
margin |
number
|
<optional> |
Margin inside the components zone, only used for container. |
gap |
number
|
<optional> |
Gap between component inside the components zone, only used for container. |
Members
Array.<ComponentAttributeDefinition>
# definedAttributes
Defined attributes for this type.
- Default Value:
- []
string
|
null
# linkModel
Name of SVG template to render the link of this component, only used in case of workflow.
string
# workflowDirection
Workflow direction, can be horizontal or vertical.
- Default Value:
- horizontal