Skip to main content
View as Markdown

RuleViolationRelatedObject

EXPERIMENTAL

Experimental​

caution

Not production-ready. It may change or be removed without notice. See Lifecycle.

Represents a design object related to a rule violation.

Member Of​

RuleViolation_Preview object ● RuleViolation object

type RuleViolationRelatedObject {
  boundingRectangle: RuleViolationRectangle
  designator: String!
  documentId: String!
  location: RuleViolationLocation
  name: String!
  type: String!
  uniqueId: String!
  variantId: String
  variantName: String
}

Fields​

boundingRectangle ● RuleViolationRectangle object​

The bounding rectangle of the related object.

designator ● String! non-null scalar​

The designator of the related object.

documentId ● String! non-null scalar​

The identifier of the document containing the related object.

location ● RuleViolationLocation object​

The location of the related object.

name ● String! non-null scalar​

The name of the related object.

type ● String! non-null scalar​

The type of the related object. Known values: DOCUMENT, PIN, NET, COMPONENT, PART, LINE, NET_ITEM, VARIANT. New values may be added; clients must tolerate unknown values.

uniqueId ● String! non-null scalar​

The unique identifier of the related object.

variantId ● String scalar​

The variant identifier of the related object.

variantName ● String scalar​

The variant name of the related object.