---
title: "ViewerConfiguration | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ViewerConfiguration/"
---

# ViewerConfiguration

> - [`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration)

## Classes

### ViewerConfiguration

#### Implements

#### Constructors

##### Constructor

```ts
new ViewerConfiguration(conf): ViewerConfiguration;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `conf` | [`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration) |

###### Returns

[`ViewerConfiguration`](#viewerconfiguration)

#### Properties

##### alignToSafetyLineName

```ts
alignToSafetyLineName: string;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`alignToSafetyLineName`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#aligntosafetylinename)

##### apiClientConfiguration

```ts
apiClientConfiguration: IApiClientConfiguration;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`apiClientConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#apiclientconfiguration)

##### curvedTextBaselineDrawStates?

```ts
optional curvedTextBaselineDrawStates?: ItemHandlerState[];
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`curvedTextBaselineDrawStates`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#curvedtextbaselinedrawstates)

##### disableCustomScrollbarStyle

```ts
disableCustomScrollbarStyle: boolean;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`disableCustomScrollbarStyle`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#disablecustomscrollbarstyle)

##### floatingToolbar

```ts
floatingToolbar: IFloatingItemToolbarConfig;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`floatingToolbar`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#floatingtoolbar)

##### grid

```ts
grid: GridConfig;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`grid`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#grid)

##### handlers

```ts
handlers: IHandlersConfiguration;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`handlers`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#handlers)

##### historySize

```ts
historySize: number;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`historySize`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#historysize)

##### imageResizeRequestConfig?

```ts
optional imageResizeRequestConfig?: ImageResizeRequestConfig;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`imageResizeRequestConfig`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#imageresizerequestconfig)

##### inactiveContainerTransparencyEnabled

```ts
inactiveContainerTransparencyEnabled: boolean = true;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`inactiveContainerTransparencyEnabled`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#inactivecontainertransparencyenabled)

##### inactiveContainerTransparencyLevel

```ts
inactiveContainerTransparencyLevel: number = 0.8;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`inactiveContainerTransparencyLevel`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#inactivecontainertransparencylevel)

##### listSettings

```ts
listSettings: IListConfiguration;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`listSettings`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#listsettings)

##### messages

```ts
messages: IViewerMessagesConfig;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`messages`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#messages)

##### mockupMarginWorkaroundEnabled

```ts
mockupMarginWorkaroundEnabled: boolean;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`mockupMarginWorkaroundEnabled`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#mockupmarginworkaroundenabled)

##### printZone

```ts
printZone: IPrintZoneConfiguration;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`printZone`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#printzone)

##### productThemes

```ts
productThemes: object;
```

###### Index Signature

```ts
[name: string]: IProductThemeConfig
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`productThemes`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#productthemes)

##### renderingConfig?

```ts
optional renderingConfig?: IRenderingConfig;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`renderingConfig`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#renderingconfig)

##### rotatedTextInPlaceEditEnabled?

```ts
optional rotatedTextInPlaceEditEnabled?: boolean;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`rotatedTextInPlaceEditEnabled`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#rotatedtextinplaceeditenabled)

##### rulers

```ts
rulers: IRulersConfig;
```

##### scrollbarEnabled?

```ts
optional scrollbarEnabled?: boolean;
```

##### snapLines

```ts
snapLines: ISnapLinesConfiguration;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`snapLines`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#snaplines)

##### stubImages

```ts
stubImages: StubImagesConfig;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`stubImages`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#stubimages)

##### style

```ts
style: ICanvasStyle;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`style`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#style)

##### surfaceShadowEnabled

```ts
surfaceShadowEnabled: boolean;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`surfaceShadowEnabled`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#surfaceshadowenabled)

##### text

```ts
text: ITextParams;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`text`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#text)

##### textEditor

```ts
textEditor: TextEditorMode;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`textEditor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#texteditor)

##### variableItemsMaskSymbol

```ts
variableItemsMaskSymbol: string;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`variableItemsMaskSymbol`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#variableitemsmasksymbol)

##### violationService

```ts
violationService: IViolationServiceConfiguration;
```

###### Implementation of

[`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration).[`violationService`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#violationservice)

##### zoom

```ts
zoom: IRangeParams;
```