Back to Website
Show / Hide Table of Contents

Interface IEditorConfig

Provides the main configuration for the Data-Driven Editor. Example:

{
  "access": { "tenantId": "tenant1", "userId": "user1", "token": "token1" },
  "design": { "designId": "design1", "dataSetId": "dataset1" },
  "api": { "designAtoms": "https://api.example.com/design-atoms" },
  "settings": { "lang": "en", "allowManipulations": false },
  "renderer": { "width": 800, "height": 600, "format": "Pdf" }
}
Package: ui-framework

Properties

access

Access credentials for the editor.

Declaration
access: Partial<IEditorAccess>
Property Value
Type Description
Partial<IEditorAccess>

Access credentials for the editor.

api

API endpoints for the editor services.

Declaration
api: IEditorAPI
Property Value
Type Description
IEditorAPI

API endpoints for the editor services.

design

Design configuration.

Declaration
design: Partial<IDesignConfig>
Property Value
Type Description
Partial<IDesignConfig>

Design configuration.

preview

Preview image dimensions.

Declaration
preview: Object
Property Value
Type Description
Object

Preview image dimensions.

renderer

Rendering configuration.

Declaration
renderer: IRendererConfig
Property Value
Type Description
IRendererConfig

Rendering configuration.

settings

Editor settings.

Declaration
settings?: IEditorSettings
Property Value
Type Description
IEditorSettings

Editor settings.

translation

Interface translation configuration.

Declaration
translation?: Record<string, any>
Property Value
Type Description
Record<string, any>

Interface translation configuration.

userInfo

User information for automatic form filling.

Declaration
userInfo?: Record<string, string>
Property Value
Type Description
Record<string, string>

User information for automatic form filling.

Was this page helpful?
Thanks for your feedback!
Back to top Copyright © 2001–2025 Aurigma, Inc. All rights reserved.
Loading...
    Thank for your vote
    Your opinion is important to us. To provide details, send feedback.
    Send feedback