Breaking Changes in 6.0

We actively develop Customer's Canvas API and realize that critical changes may be unacceptable and complicate the update process. When some API elements become inconsistent and inconvenient, we first declare them deprecated, and they work in parallel with the new functionality for a while. In further major releases, we delete such deprecated elements.

This topic describes breaking changes in configuration parameters, markers, and the Web API that appear in Customer's Canvas 6.

Changed configuration parameters
Removed parameters
Removed markers
Changes in the Web API

Changed Parameters in Configuration Files

clientConfig.json

Parameter Name	Old Value	New Value
watermark.text.fontSettings	"ArialMT"	"Roboto-Regular"

AppSettings.config

Parameter Name	Old Value	New Value
FontSubstitutionEnabled	"True"	"False"
SubstitutionFontPostScriptName	"ArialMT"	"Roboto-Regular"
DefaultFontPostScriptName	"ArialMT"	"Roboto-Regular"

Removed Configuration Parameters

AppSettings.config

Parameter Name	An Alternative
ParagraphTextEnabled	Not applicable

clientConfig.json

Parameter Name	An Alternative
arbitraryResizeForImageItemEnabled	IResizeGripsPermissions
defaultAssetSelectWidget	Not applicable
newImageName	defaultItemsConfig.image.name
canvas.snapLines.enabled	canvas.snapLines.{type}.enabled
canvas.snapLines.color	canvas.snapLines.{type}.color
canvas.snapLines.tolerance	canvas.snapLines.{type}.tolerance
canvas.ZoomStep	canvas.zoom
widgets.BottomToolbar.snapLinesCheckboxEnabled	widgets.BottomToolbar.snapLines{type}CheckboxEnabled
widgets.ColorPicker.defaultColorSpace	widgets.ColorPicker.colorSpace
widgets.ColorPicker.availableColorSpaces	Not applicable
widgets.ColorPicker.palette	IPaletteSection

Removed Markers

Marker Name	An Alternative
`<DPH>`	`Dynamic Image API`

Changes in the Web API

POST ~/api/Preview/GeneratePreview

POST ~/api/HiRes/GenerateHiRes

Old Parameter	New Parameter
previewOptions.width	previewOptions.maxWidth
previewOptions.height	previewOptions.maxHeight