Skip to main content

View

A view on the architecture graph of a project

type View implements BaseNode, Named, NamedNode, Node {
  description: String!
  filterByTemplate(
    after: String
    before: String
    filter: ComponentTemplateFilterInput
    first: Int
    last: Int
    orderBy: [ComponentTemplateOrder!]
    skip: Int
  ): ComponentTemplateConnection!
  hasPermission(
    permission: AllPermissionEntry
  ): Boolean!
  id: ID!
  name: String!
  project: Project!
  relationLayouts(
    after: String
    before: String
    filter: RelationLayoutFilterInput
    first: Int
    last: Int
    orderBy: [RelationLayoutOrder!]
    skip: Int
  ): RelationLayoutConnection!
  relationPartnerLayouts(
    after: String
    before: String
    filter: RelationPartnerLayoutFilterInput
    first: Int
    last: Int
    orderBy: [RelationPartnerLayoutOrder!]
    skip: Int
  ): RelationPartnerLayoutConnection!
}

Fields​

View.description ● String! non-null scalar​

The description of this entity.

View.filterByTemplate ● ComponentTemplateConnection! non-null object​

Filter which ComponentVersions are shown in this view

View.filterByTemplate.after ● String scalar​

Get only items after the cursor

View.filterByTemplate.before ● String scalar​

Get only items before the cursor

View.filterByTemplate.filter ● ComponentTemplateFilterInput input​

Filter for specific items in the connection

View.filterByTemplate.first ● Int scalar​

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

View.filterByTemplate.last ● Int scalar​

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

View.filterByTemplate.orderBy ● [ComponentTemplateOrder!] list input​

Order in which the items are sorted

View.filterByTemplate.skip ● Int scalar​

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

View.hasPermission ● Boolean! non-null scalar​

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

View.hasPermission.permission ● AllPermissionEntry enum​

The permission to check for

View.id ● ID! non-null scalar​

The unique id of this node

View.name ● String! non-null scalar​

The name of this entity.

View.project ● Project! non-null object​

The project this view is for

View.relationLayouts ● RelationLayoutConnection! non-null object​

Layouts for relations

View.relationLayouts.after ● String scalar​

Get only items after the cursor

View.relationLayouts.before ● String scalar​

Get only items before the cursor

View.relationLayouts.filter ● RelationLayoutFilterInput input​

Filter for specific items in the connection

View.relationLayouts.first ● Int scalar​

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

View.relationLayouts.last ● Int scalar​

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

View.relationLayouts.orderBy ● [RelationLayoutOrder!] list input​

Order in which the items are sorted

View.relationLayouts.skip ● Int scalar​

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

View.relationPartnerLayouts ● RelationPartnerLayoutConnection! non-null object​

Layouts for relation partners

View.relationPartnerLayouts.after ● String scalar​

Get only items after the cursor

View.relationPartnerLayouts.before ● String scalar​

Get only items before the cursor

View.relationPartnerLayouts.filter ● RelationPartnerLayoutFilterInput input​

Filter for specific items in the connection

View.relationPartnerLayouts.first ● Int scalar​

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

View.relationPartnerLayouts.last ● Int scalar​

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

View.relationPartnerLayouts.orderBy ● [RelationPartnerLayoutOrder!] list input​

Order in which the items are sorted

View.relationPartnerLayouts.skip ● Int scalar​

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

Interfaces​

BaseNode interface​

Shared extensions to the node type.

Named interface​

Entity with a name and a description.

NamedNode interface​

Node with a name and description

Node interface​

Base class of all nodes

Returned by​

searchViews query

Member of​

CreateViewPayload object ● Project object ● RelationLayout object ● RelationPartnerLayout object ● UpdateViewPayload object ● ViewConnection object ● ViewEdge object