This is an old documentation. Go to the latest Customer's Canvas docs

IViolationWarningsSettingsConfig Interface

A structure containing the configuration of preflight warnings.

example
{
    "violationWarningsSettings": {
        "qualityMeter": {
            "enabled": true,
            "qualityLevels": {
                "warning": "99",
                "bad": "50"
            }
        },
        "regionViolationWarningEnabled": true,
        "safetyLineViolationWarningEnabled": false
    },

    "canvas": {
        "violationWarningButtonsEnabled": true,
        "qualityChangeContainersEnabled": true
    },

    "widgets": {
        "ObjectInspector": {
            "violationWarningsEnabled": true
        }
    }
}

Properties

Optional inPlaceNotSupportedWarningEnabled

inPlaceNotSupportedWarningEnabled: boolean

Enables warnings displayed when text elements have properties that are not supported in the WYSIWYG text engine and when the Classic text engine will render this text. The default value is false.

Optional qualityMeter

qualityMeter: IQualityMeterConfig

Enables a warning displayed if a selected image has a resolution that is too low.

Optional regionViolationWarningEnabled

regionViolationWarningEnabled: boolean

Enables a warning displayed if an item goes out of a region. The default value is true.

Optional safetyLineViolationWarningEnabled

safetyLineViolationWarningEnabled: boolean

Enables a warning displayed if an item crosses a safety line. The default value is true.

Optional shapeViolationsEnabled

shapeViolationsEnabled: boolean

Enables a warning displayed if the Asset Manager can import PDF and SVG graphics only with the loss of colors and raster images. The default value is true.

Optional textCropViolationWarningEnabled

textCropViolationWarningEnabled: boolean

Enables a warning displayed if the text is too long for the bounding rectangle, and some strings are clipped. The default value is true.

Optional tolerance

tolerance: number

Defines a distance, in points, within which no warnings about violations of safety lines or the bleed zone will be displayed.