DefaultConfig Module

The default 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)"
        },
        boundedText: {
            tracking: 27,
            leading: 125,
            verticalAlignment: "center",
            isVertical: true
        }
    }
};

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

Modules

Name Description
WrappingMode

Text wrapping modes.

Interfaces

Name Description
IBarcodeDefaultConfig

A structure defining the default parameters of barcodes.

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 bounded text and images.

IEllipseItemDefaultConfig

A structure defining the default parameters of ellipses.

IFontDefaultConfig

A structure defining the default parameters of fonts.

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 common parameters of design elements.

IItemPermissionsConfig

A structure defining common permissions for design elements.

ILineItemDefaultConfig

A structure containing default parameters of lines.

ILinePermissionsConfig

A structure defining permissions for lines.

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.

IRectangleItemDefaultConfig

A structure defining the default parameters of rectangles.

IRichTextConfig

A structure defining the rich text parameters.

IShadowDefaultConfig

A structure defining the default parameters of the text shadow.

IShapeItemDefaultConfig

A structure defining common shape parameters.

IShapePermissionsConfig

A structure defining permissions for shapes.

IStrokeDefaultConfig

A structure defining the default parameters of the text stroke.

ITextConfig

A structure defining the text parameters.

IVisualizationPermissionsConfig

A structure defining visualization of design elements.

Type aliases

VerticalAlignmentType

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