Constructor
# new ComponentAttributeDefinition(propsopt)
Default constructor
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
props |
object
|
<optional> |
Object that contains all properties to set. |
name |
string
|
<optional> |
Attribute name. |
type |
string
|
<optional> |
Attribute type, valid types are String/Boolean/Number/Array/Object/Link/Reference. |
displayName |
string
|
<optional> |
Attribute display name. |
description |
string
|
<optional> |
Attribute explanation. |
tags |
Array.<string>
|
<optional> |
Attribute tags. |
url |
string
|
<optional> |
URL of the documentation of the attribute. |
linkType |
string
|
<optional> |
Type of link, valid types are Default/Reverse. |
linkRef |
Array.<string>
|
<optional> |
Reference of accepted component for link. |
linkModel |
Array.<string>
|
<optional> |
Name of SVG model to render the link of component. |
containerRef |
string
|
<optional> |
Reference of accepted component for container. |
required |
boolean
|
<optional> |
Attribute is required. |
definedAttributes |
Array.<ComponentAttributeDefinition>
|
<optional> |
Defined attributes for this type. |
rules |
object
|
<optional> |
Rules of this type of Attribute. |
rules.values |
Array
|
<optional> |
Default values of attribute. |
rules.min |
number
|
<optional> |
Minimum value of Attribute. |
rules.max |
number
|
<optional> |
Maximum value of Attribute. |
rules.regex |
string
|
<optional> |
Regular expression to constrain the format of the value. |
rules.regexMessage |
string
|
<optional> |
Message so use in case of regex error. |
Members
string
# containerRef
Define the reference of Component that can be the container of this component.
Array.<string>
# linkRef
Define list of Component that can be linked with this.
- Default Value:
- []
View Source models/ComponentAttributeDefinition.js, line 106
boolean
# required
Attribute is required.
- Default Value:
- false
View Source models/ComponentAttributeDefinition.js, line 127