Skip to main content

RuleViolationRelatedObject

**Experimental** Represents a design object related to a rule violation.

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

Fields​

RuleViolationRelatedObject.boundingRectangle ● RuleViolationRectangle object​

**Experimental** The bounding rectangle of the related object.

RuleViolationRelatedObject.designator ● String! non-null scalar​

**Experimental** The designator of the related object.

RuleViolationRelatedObject.documentId ● String! non-null scalar​

**Experimental** The identifier of the document containing the related object.

RuleViolationRelatedObject.location ● RuleViolationLocation object​

**Experimental** The location of the related object.

RuleViolationRelatedObject.name ● String! non-null scalar​

**Experimental** The name of the related object.

RuleViolationRelatedObject.type ● String! non-null scalar​

**Experimental** 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.

RuleViolationRelatedObject.uniqueId ● String! non-null scalar​

**Experimental** The unique identifier of the related object.

RuleViolationRelatedObject.variantId ● String scalar​

**Experimental** The variant identifier of the related object.

RuleViolationRelatedObject.variantName ● String scalar​

**Experimental** The variant name of the related object.