Configuration

The editor configuration.

structure
//common properties
canvas: {
    //...
    rulers: { /*...*/  }
},
grid: { /*...*/  },
rendering: { /*...*/  },
widgets: {
    BottomToolbar: { /*...*/  },
    ColorPicker: { /*...*/  },
    FinishButton: { /*...*/  },
    GalleryDialog: {
        //...
        socialNetworkAppIds: { /*...*/  }
    },
    ImageEditorDialog: { /*...*/  },
    ItemMenu: { /*...*/  },
    LeftToolbar: { /*...*/  },
    LinearBarcodeDialog: { /*...*/  },
    RichTextDialog: {
        //...
        textOutline: { /*...*/  }
    },
    ObjectInspector: { /*...*/  },
    QrCodeDialog: { /*...*/  },
    TopToolbar: {
        //...
        fontSizeParams: { /*...*/  }
    }
}

Modules

Name Description
BarcodeType

Bar codes.

FinishButtonMode

Modes of the Finish design button.

FontListMode

Modes of the font list.

GalleryDialogTab

A default tab opened in the Gallery.

ModelMode

Editor modes.

ObjectInspectorPosition

Object Inspector Position.

RulersConfigUnit

Ruler units.

Interfaces

Name Description
IAutoZoomConfig

A structure containing auto zoom configuration of the rich text editor.

IBarcodeDialogConfig

A structure containing configuration of the Barcode dialog.

IBottomToolbarConfig

A structure containing configuration of the Bottom toolbar.

ICanvasConfig

A structure containing canvas settings in the editor.

IClientConfiguration

Basic structure for IConfiguration, contains editor settings.

IColorPickerConfig

The color picker providing color selection in the editor. See the Colors topic for details.

ICommonConfig

A structure for common font settings.

IConfiguration

A structure containing the web-to-print editor configuration. Extends IClientConfiguration.

IFinishButtonConfig

Configuration of the Finish design button.

IGalleryDialogConfig

A structure defining settings of the Gallery dialog.

IGridConfig

Grid configuration. See the Markings topic for details.

IImageEditorDialogConfig

A structure defining settings of the Image editor dialog.

IItemMenuConfig

A structure defining settings of the Item menu.

ILeftToolbarConfig

A structure containing configuration of the Left toolbar.

IObjectInspectorConfig

A structure containing configuration of the Object inspector.

IPdfMetadata

A structure containing PDF metadata to be saved in the hi-res output.

IPerSurfaceConfiguration

A configuration of widgets, that is defined for separate surfaces.

IRangeParams

A structure defining a range of values.

IRenderingConfig

A structure containing Hi-res output and proof images configuration. See the Configuring High Resolution and Proof Images topic for details.

IRichComboValuesConfig

An object defining indent and padding values for the Rich text dialog

IRichTextDialogConfig

The dialog providing rich text formatting options. See the Rich Text Editor topic for details.

IRulersConfig

A structure containing configuration of rulers. See the Markings topic for details.

ISnapLinesConfig

A structure containing configuration of snap lines.

ISocialNetworkAppIds

Instagram and/or Facebook identifiers for your application. See the Integration with Facebook and Instagram topic.

ITextOutline

Text outline dialog for low-contrast text in the Rich Text. The feature is turned off by default.

ITextShadowParam

A structure defining a range of values.

ITopToolbarConfig

A structure containing configuration of the Top toolbar.

IWidgetConfigsForSurface

A structure defining the configuration of widgets for a separate surface.

IWidgetsConfig

Configuration of the editor widgets. See the Customizing User Interface topic for details.

IZoomConfig

A structure containing text zoom configuration of the rich text editor.