Skip to content

ComponentTemplate

Template for Components. Defines templated fields with specific types (defined using JSON schema). Defines SubTemplate for ComponentVersions.

graphql
type ComponentTemplate implements BaseNode, BaseTemplate, Named, NamedNode, Node, RelationPartnerTemplate, Template {
  componentVersionTemplate: ComponentVersionTemplate!
  description: String!
  extendedBy(
    after: String
    before: String
    filter: ComponentTemplateFilterInput
    first: Int
    last: Int
    orderBy: [ComponentTemplateOrder!]
    skip: Int
  ): ComponentTemplateConnection!
  extends(
    after: String
    before: String
    filter: ComponentTemplateFilterInput
    first: Int
    last: Int
    orderBy: [ComponentTemplateOrder!]
    skip: Int
  ): ComponentTemplateConnection!
  fill: FillStyle
  hasPermission(
    permission: AllPermissionEntry
  ): Boolean!
  id: ID!
  intraComponentDependencySpecificationTypes(
    after: String
    before: String
    filter: IntraComponentDependencySpecificationTypeFilterInput
    first: Int
    last: Int
    orderBy: [IntraComponentDependencySpecificationTypeOrder!]
    skip: Int
  ): IntraComponentDependencySpecificationTypeConnection!
  isAbstract: Boolean!
  isDeprecated: Boolean!
  name: String!
  possibleEndOfRelations(
    after: String
    before: String
    filter: RelationConditionFilterInput
    first: Int
    last: Int
    orderBy: [RelationConditionOrder!]
    skip: Int
  ): RelationConditionConnection!
  possibleInvisibleInterfaceSpecifications(
    after: String
    before: String
    filter: InterfaceSpecificationTemplateFilterInput
    first: Int
    last: Int
    orderBy: [InterfaceSpecificationTemplateOrder!]
    skip: Int
  ): InterfaceSpecificationTemplateConnection!
  possibleStartOfRelations(
    after: String
    before: String
    filter: RelationConditionFilterInput
    first: Int
    last: Int
    orderBy: [RelationConditionOrder!]
    skip: Int
  ): RelationConditionConnection!
  possibleVisibleInterfaceSpecifications(
    after: String
    before: String
    filter: InterfaceSpecificationTemplateFilterInput
    first: Int
    last: Int
    orderBy: [InterfaceSpecificationTemplateOrder!]
    skip: Int
  ): InterfaceSpecificationTemplateConnection!
  shapeRadius: Float
  shapeType: ShapeType!
  stroke: StrokeStyle
  templateFieldSpecifications(
    namePrefix: String
  ): [JSONField!]!
  usedIn(
    after: String
    before: String
    filter: ComponentFilterInput
    first: Int
    last: Int
    orderBy: [ComponentOrder!]
    skip: Int
  ): ComponentConnection!
}

Fields

ComponentTemplate.componentVersionTemplate ● ComponentVersionTemplate! non-null object

SubTemplate applied to all ComponentVersions of Components with this Template

ComponentTemplate.description ● String! non-null scalar

The description of this entity.

ComponentTemplate.extendedBy ● ComponentTemplateConnection! non-null object

Templates that extend this template.

ComponentTemplate.extendedBy.after ● String scalar

Get only items after the cursor

ComponentTemplate.extendedBy.before ● String scalar

Get only items before the cursor

ComponentTemplate.extendedBy.filter ● ComponentTemplateFilterInput input

Filter for specific items in the connection

ComponentTemplate.extendedBy.first ● Int scalar

Get the first n items. Must not be used if before is specified

ComponentTemplate.extendedBy.last ● Int scalar

Get the last n items. Must not be used if after is specified

ComponentTemplate.extendedBy.orderBy ● [ComponentTemplateOrder!] list input

Order in which the items are sorted

ComponentTemplate.extendedBy.skip ● Int scalar

Skips n items. First or last MUST be specified, is otherwise ignored

ComponentTemplate.extends ● ComponentTemplateConnection! non-null object

Template this template extends.

ComponentTemplate.extends.after ● String scalar

Get only items after the cursor

ComponentTemplate.extends.before ● String scalar

Get only items before the cursor

ComponentTemplate.extends.filter ● ComponentTemplateFilterInput input

Filter for specific items in the connection

ComponentTemplate.extends.first ● Int scalar

Get the first n items. Must not be used if before is specified

ComponentTemplate.extends.last ● Int scalar

Get the last n items. Must not be used if after is specified

ComponentTemplate.extends.orderBy ● [ComponentTemplateOrder!] list input

Order in which the items are sorted

ComponentTemplate.extends.skip ● Int scalar

Skips n items. First or last MUST be specified, is otherwise ignored

ComponentTemplate.fill ● FillStyle object

Style of the fill

ComponentTemplate.hasPermission ● Boolean! non-null scalar

Checks if the current user has a specific permission on this Node

ComponentTemplate.hasPermission.permission ● AllPermissionEntry enum

The permission to check for

ComponentTemplate.id ● ID! non-null scalar

The unique id of this node

ComponentTemplate.intraComponentDependencySpecificationTypes ● IntraComponentDependencySpecificationTypeConnection! non-null object

IntraComponentDependencySpecificationTypes which can be used in the context of Components with this template.

ComponentTemplate.intraComponentDependencySpecificationTypes.after ● String scalar

Get only items after the cursor

ComponentTemplate.intraComponentDependencySpecificationTypes.before ● String scalar

Get only items before the cursor

ComponentTemplate.intraComponentDependencySpecificationTypes.filter ● IntraComponentDependencySpecificationTypeFilterInput input

Filter for specific items in the connection

ComponentTemplate.intraComponentDependencySpecificationTypes.first ● Int scalar

Get the first n items. Must not be used if before is specified

ComponentTemplate.intraComponentDependencySpecificationTypes.last ● Int scalar

Get the last n items. Must not be used if after is specified

ComponentTemplate.intraComponentDependencySpecificationTypes.orderBy ● [IntraComponentDependencySpecificationTypeOrder!] list input

Order in which the items are sorted

ComponentTemplate.intraComponentDependencySpecificationTypes.skip ● Int scalar

Skips n items. First or last MUST be specified, is otherwise ignored

ComponentTemplate.isAbstract ● Boolean! non-null scalar

If true, this template is abstract and cannot be used for new entities.

ComponentTemplate.isDeprecated ● Boolean! non-null scalar

If true, this template is deprecated and cannot be used for new entities any more.

ComponentTemplate.name ● String! non-null scalar

The name of this entity.

ComponentTemplate.possibleEndOfRelations ● RelationConditionConnection! non-null object

RelationConditions which allow this template for the end of the relation.

ComponentTemplate.possibleEndOfRelations.after ● String scalar

Get only items after the cursor

ComponentTemplate.possibleEndOfRelations.before ● String scalar

Get only items before the cursor

ComponentTemplate.possibleEndOfRelations.filter ● RelationConditionFilterInput input

Filter for specific items in the connection

ComponentTemplate.possibleEndOfRelations.first ● Int scalar

Get the first n items. Must not be used if before is specified

ComponentTemplate.possibleEndOfRelations.last ● Int scalar

Get the last n items. Must not be used if after is specified

ComponentTemplate.possibleEndOfRelations.orderBy ● [RelationConditionOrder!] list input

Order in which the items are sorted

ComponentTemplate.possibleEndOfRelations.skip ● Int scalar

Skips n items. First or last MUST be specified, is otherwise ignored

ComponentTemplate.possibleInvisibleInterfaceSpecifications ● InterfaceSpecificationTemplateConnection! non-null object

Templates of InterfaceSpecifications which can be invisible on Components with this Template.

ComponentTemplate.possibleInvisibleInterfaceSpecifications.after ● String scalar

Get only items after the cursor

ComponentTemplate.possibleInvisibleInterfaceSpecifications.before ● String scalar

Get only items before the cursor

ComponentTemplate.possibleInvisibleInterfaceSpecifications.filter ● InterfaceSpecificationTemplateFilterInput input

Filter for specific items in the connection

ComponentTemplate.possibleInvisibleInterfaceSpecifications.first ● Int scalar

Get the first n items. Must not be used if before is specified

ComponentTemplate.possibleInvisibleInterfaceSpecifications.last ● Int scalar

Get the last n items. Must not be used if after is specified

ComponentTemplate.possibleInvisibleInterfaceSpecifications.orderBy ● [InterfaceSpecificationTemplateOrder!] list input

Order in which the items are sorted

ComponentTemplate.possibleInvisibleInterfaceSpecifications.skip ● Int scalar

Skips n items. First or last MUST be specified, is otherwise ignored

ComponentTemplate.possibleStartOfRelations ● RelationConditionConnection! non-null object

RelationConditions which allow this template for the start of the relation.

ComponentTemplate.possibleStartOfRelations.after ● String scalar

Get only items after the cursor

ComponentTemplate.possibleStartOfRelations.before ● String scalar

Get only items before the cursor

ComponentTemplate.possibleStartOfRelations.filter ● RelationConditionFilterInput input

Filter for specific items in the connection

ComponentTemplate.possibleStartOfRelations.first ● Int scalar

Get the first n items. Must not be used if before is specified

ComponentTemplate.possibleStartOfRelations.last ● Int scalar

Get the last n items. Must not be used if after is specified

ComponentTemplate.possibleStartOfRelations.orderBy ● [RelationConditionOrder!] list input

Order in which the items are sorted

ComponentTemplate.possibleStartOfRelations.skip ● Int scalar

Skips n items. First or last MUST be specified, is otherwise ignored

ComponentTemplate.possibleVisibleInterfaceSpecifications ● InterfaceSpecificationTemplateConnection! non-null object

Templates of InterfaceSpecifications which can be visible on Components with this Template.

ComponentTemplate.possibleVisibleInterfaceSpecifications.after ● String scalar

Get only items after the cursor

ComponentTemplate.possibleVisibleInterfaceSpecifications.before ● String scalar

Get only items before the cursor

ComponentTemplate.possibleVisibleInterfaceSpecifications.filter ● InterfaceSpecificationTemplateFilterInput input

Filter for specific items in the connection

ComponentTemplate.possibleVisibleInterfaceSpecifications.first ● Int scalar

Get the first n items. Must not be used if before is specified

ComponentTemplate.possibleVisibleInterfaceSpecifications.last ● Int scalar

Get the last n items. Must not be used if after is specified

ComponentTemplate.possibleVisibleInterfaceSpecifications.orderBy ● [InterfaceSpecificationTemplateOrder!] list input

Order in which the items are sorted

ComponentTemplate.possibleVisibleInterfaceSpecifications.skip ● Int scalar

Skips n items. First or last MUST be specified, is otherwise ignored

ComponentTemplate.shapeRadius ● Float scalar

The corner radius of the shape, ignored for circle/ellipse.

ComponentTemplate.shapeType ● ShapeType! non-null enum

The type of the shape.

ComponentTemplate.stroke ● StrokeStyle object

Style of the stroke

ComponentTemplate.templateFieldSpecifications ● [JSONField!]! non-null object

All template field specifications, if a namePrefix is provided, only those matching it

ComponentTemplate.templateFieldSpecifications.namePrefix ● String scalar

Name of the extension field.

ComponentTemplate.usedIn ● ComponentConnection! non-null object

Entities which use this template.

ComponentTemplate.usedIn.after ● String scalar

Get only items after the cursor

ComponentTemplate.usedIn.before ● String scalar

Get only items before the cursor

ComponentTemplate.usedIn.filter ● ComponentFilterInput input

Filter for specific items in the connection

ComponentTemplate.usedIn.first ● Int scalar

Get the first n items. Must not be used if before is specified

ComponentTemplate.usedIn.last ● Int scalar

Get the last n items. Must not be used if after is specified

ComponentTemplate.usedIn.orderBy ● [ComponentOrder!] list input

Order in which the items are sorted

ComponentTemplate.usedIn.skip ● Int scalar

Skips n items. First or last MUST be specified, is otherwise ignored

Interfaces

BaseNode interface

Shared extensions to the node type.

BaseTemplate interface

Base type for both Template and SubTemplate. Defines templated fields with specific types (defined using JSON schema). READ is always granted.

Named interface

Entity with a name and a description.

NamedNode interface

Node with a name and description

Node interface

Base class of all nodes

RelationPartnerTemplate interface

Template for RelationPartners.

Template interface

BaseTemplate with composition features. Can have SubTemplates. Defines templated fields with specific types (defined using JSON schema).

Returned By

searchComponentTemplates query

Member Of

Component object ● ComponentTemplateConnection object ● ComponentTemplateEdge object ● ComponentVersionTemplate object ● CreateComponentTemplatePayload object ● UpdateComponentTemplatePayload object

Released under the MIT License.