---
title: "IViolationWarningData Interface"
canonical: https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.editor.iviolationwarningdata.htm
archived: true
applies_to:
  - product: "Customer's Canvas On-Premises"
  - product: "Design Editor"
    versions: ["6.15.0", "6.x (may differ)"]
---

**You’re viewing outdated documentation.** [View the latest Customer’s Canvas On-Premises documentation](https://customerscanvas.com/docs/on-premises/).

# IViolationWarningData Interface

**Applies to:** Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · **Archived documentation**
 
A structure containing details about design elements that have preflight problems.
  
 - example
     - ```
editor.finishProductDesign()

    // If product customization is completed successfully.
    .then(function (result) {
        // Get the promise properties.
        stateId = result.stateId;
        userId = result.userId;
        returnToEditUrl = result.returnToEditUrl;
        preflightProblems = result.violationWarningData;

        console.log("User " + userId + " successfully saved state " + stateId);
        if (preflightProblems.length > 0)
            console.log("The preflight check found some problems.");
    })

    // If there was an error thrown when completing product customization.
    .catch(function (error) {
        console.error("Completing product customization failed with exception: ", error);
    });
```
 
## Properties
 
### Optional dpiValue
 
dpiValue: number

A resolution of images or image placeholders that have the `Warning` or `Bad` states of the resolution check.
 
### name
 
name: string

A name of the design element.
 
### Optional qualityViolationState
 
qualityViolationState: [ViolationState](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.editor.violationstate.htm.md)

A state of the resolution check of images and image placeholders. This value is either `Good`, `Warning`, or `Bad`.
 
### Optional regionViolationState
 
regionViolationState: [Warning](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.editor.violationstate.htm.md)  |  [Good](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.editor.violationstate.htm.md)

A state of the out-of-region check. If `Warning`, the design element goes out of the region.
 
### Optional safetyLineViolationState
 
safetyLineViolationState: [Warning](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.editor.violationstate.htm.md)  |  [Good](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.editor.violationstate.htm.md)

A state of the bleed zone violation check. If `Warning`, the design element goes out of the safety lines.
 
### surfaceIndex
 
surfaceIndex: number

An index of the surface containing the design element.
 
### surfaceName
 
surfaceName: string

A name of the surface containing the design element.
 
### Optional textCropViolationState
 
textCropViolationState: [Warning](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.editor.violationstate.htm.md)  |  [Good](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.editor.violationstate.htm.md)

A state of the text clipping check.
 
### type
 
type: string

A type of the design element, for example, `PlainTextItem` or `ImageItem`.