DefaultConfig Module

The configuration of design elements being added to the canvas.

example
configuration = {
    defaultItemsConfig: {
        text: {
            font: {
                postScriptName: "Impact",
                size: 33,
                fauxBold: true,
                fauxItalic: true
            },
            color: "rgb(0,255,255)",
            verticalAlignment: "center",
            isVertical: true
        },
        image: {
            location: {
                x: "100%",    y: "100%",
                originX: "right", originY: "bottom"
            },
            width: "25%",
            manipulationPermissions: {
                resizeGrips: {
                    edge: true,
                    corner: ["Arbitrary"]
                }
            }
        }
    }
};

CustomersCanvas.IframeApi.loadEditor(iframe, productDefinition, configuration);

Modules

Name Description
WrappingMode

Text wrapping modes.

Enumerations

Name Description
OriginPointType

The origin of coordinates.

TextAlignment

Text alignment types.

Interfaces

Name Description
IBarcodeDefaultConfig

A structure defining the default parameters of barcodes.

IBarcodePermissionsConfig

A structure defining the barcode permissions.

IBaseTextItemConfig

A structure defining the basic text parameters.

IBoundedTextItemConfig

A structure defining the basic parameters of bounded text.

IContentItemDefaultConfig

A structure defining the common parameters of text elements and images.

IContentPermisssionsConfig

A structure defining permissions for the placeholder's content.

IEllipseItemDefaultConfig

A structure defining the default parameters of ellipses.

IEmptyBarcodeContent

A structure defining the content of empty barcode placeholders.

IGalleryDefaultConfig

A structure defining the default parameters of the Image Gallery.

IGalleryItemConfig

A structure defining the default parameters of gallery tabs.

IImageItemDefaultConfig

A structure containing default parameters of images.

IImagePermissionsConfig

A structure defining the image permissions.

IItemDefaultConfig

A structure containing parameters of custom design elements.

IItemPermissionsConfig

A structure defining common permissions for design elements.

IItemToolbarPermissionsConfig

A structure containing the configuration of the Floating item toolbar.

ILineItemDefaultConfig

A structure containing default parameters of lines.

ILinePermissionsConfig

A structure defining permissions for lines.

ILinearBarcodeContent

A structure defining the content of linear barcodes.

ILocationDefaultConfig

A structure defining the default location of design elements.

IManipulationPermissionsConfig

A structure defining the manipulation permissions.

IParagraphSettingsConfig

A structure defining the paragraph parameters.

IPlaceholderItemDefaultConfig

A structure defining the default parameters of image placeholders.

IPlaceholderPermissionsConfig

A structure defining the image placeholder permissions.

IPointF

A structure representing a point in a two-dimensional plane.

IQrPhoneBarcodeContent

A structure defining the content of VCard QR codes.

IQrUrlBarcodeContent

A structure defining the content of URL QR codes.

IQrVCardBarcodeContent

A structure defining the content of VCard QR codes.

IRectangleItemDefaultConfig

A structure defining the default parameters of rectangles.

IResizeGripsPermissions

A structure defining the grips that appear on bounding rectangles.

IRichTextConfig

A structure defining the rich formatted text parameters.

IShapeItemDefaultConfig

A structure defining common shape parameters.

IShapePermissionsConfig

A structure defining permissions for shapes.

IStubBarcodeContent

A structure defining the content of stub barcode placeholders.

ITextConfig

A structure defining the text parameters.

ITextPermissionsConfig

A structure defining permissions for text elements.

IThemeBindingConfig

A structure defining default colors and styles of design elements.

IVisualizationPermissionsConfig

A structure defining visualization of design elements.

Type aliases

BarcodeContentType

ContentResizeMode

ContentResizeMode: "fill" | "fit" | "original"

OverflowStrategy

OverflowStrategy: "clip" | "fitToWidth" | "fitToBox"

ShrinkMode

ShrinkMode: "scale" | "size"

VerticalAlignmentType

VerticalAlignmentType: "top" | "center" | "bottom"