Skip to main content

Interface: ISafetyLinesConfig

A structure defining the validation of safety lines and the bleed zone.

Remarks​

IViolationWarningsSettingsConfig uses this interface. You can also specify tolerance to disable warnings about violations of safety lines or the bleed zone when an object is close enough to them. For details, see the Warnings https://customerscanvas.com/dev/editors/iframe-api/editor-configuration/warnings.html|Warnings topic.

Example​

{
  "violationWarningsSettings": {
      "tolerance": 0.01,
      "safetyLines": {
          "enabled": true,
          "mode": "InsideAll"
      }
  }
}

Properties​

enabled​

enabled: boolean

If true, enables the bleed zone validation. The default value is true.

mode​

mode: SafetyLineViolationMode

The validation mode, one of:

  • "InsideAll" - a warning does not appear only if the element is inside all safety lines.

  • "PartiallyInsideAny" - a warning does not appear if at least one safety zone contains the element. This is the default value.

  • "InsideAny" - a warning does not appear if at least one safety zone contains the element, however, no safety lines should intersect the element.

Was this page helpful?