Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 | 5x 5x 5x 40x 40x 40x 40x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 2x 2x 1x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 2x 2x 40x 1x 1x 40x 5x 5x 5x 40x 2x 2x 2x 40x 1x 1x 40x 1x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 40x 1x 1x 1x | import type { EditorAPI, EditorRawAPI, EditorResponse, Id, PrivateData } from '../types/CommonTypes';
import { getEditorResponseData } from '../utils/EditorResponseData';
import {
BleedDeltaUpdate,
Layout,
LayoutIntent,
LayoutPreset,
ResizableLayoutPropertiesUpdate,
MeasurementUnit,
PositionEnum,
} from '../types/LayoutTypes';
import { CallSender } from 'penpal';
import { ColorUsage } from '../types/ColorStyleTypes';
/**
* The LayoutController is responsible for all communication regarding Layouts.
* Methods inside this controller can be called by `window.SDK.layout.{method-name}`
*/
export class LayoutController {
/**
* @ignore
*/
#editorAPI: EditorAPI;
#blobAPI: EditorRawAPI;
/**
* @ignore
*/
constructor(editorAPI: EditorAPI) {
this.#editorAPI = editorAPI;
this.#blobAPI = editorAPI as CallSender as EditorRawAPI;
}
/**
* This method returns the list of layouts
* @returns list of all layouts
*/
getAll = async () => {
const res = await this.#editorAPI;
return res.getLayouts().then((result) => getEditorResponseData<Layout[]>(result));
};
/**
* This method returns a layout by its id
* @param id the id of a specific layout
* @returns layout properties
*/
getById = async (id: Id) => {
const res = await this.#editorAPI;
return res.getLayoutById(id).then((result) => getEditorResponseData<Layout>(result));
};
/**
* This method returns a layout by its name
* @param name the name of a specific layout
* @returns layout properties
*/
getByName = async (name: string) => {
const res = await this.#editorAPI;
return res.getLayoutByName(name).then((result) => getEditorResponseData<Layout>(result));
};
/**
* This method returns the selected layout
* @returns layout properties
*/
getSelected = async () => {
const res = await this.#editorAPI;
return res.getSelectedLayout().then((result) => getEditorResponseData<Layout>(result));
};
/**
* This method will remove a specific layout
* @param id the id of a specific layout
* @returns
*/
remove = async (id: Id) => {
const res = await this.#editorAPI;
return res.removeLayout(id).then((result) => getEditorResponseData<null>(result));
};
/**
* This method will create a new child layout (a new layout is always child of a root / parent)
* @param parentId the id of a specific layout, being the parent
* @returns id of new layout
*/
create = async (parentId: Id, presets?: LayoutPreset[]) => {
const res = await this.#editorAPI;
if (presets?.length) {
return res
.addLayouts(parentId, JSON.stringify(presets))
.then((result) => getEditorResponseData<Id>(result));
}
return res.addLayout(parentId).then((result) => getEditorResponseData<Id>(result));
};
/**
* This method will update the name of a specific layout
* @param id the id of a specific layout
* @param name the new name that the layout should receive
* @returns
*/
rename = async (id: Id, name: string) => {
const res = await this.#editorAPI;
return res.renameLayout(id, name).then((result) => getEditorResponseData<null>(result));
};
/**
* This method will select a specific layout
* @param id the id of a specific layout
* @returns
*/
select = async (id: Id) => {
const res = await this.#editorAPI;
return res.selectLayout(id).then((result) => getEditorResponseData<null>(result));
};
/**
* This method will duplicate a specific layout
* @param id the id of a specific layout
* @returns id of specific layout
*/
duplicate = async (id: Id) => {
const res = await this.#editorAPI;
return res.duplicateLayout(id).then((result) => getEditorResponseData<Id>(result));
};
/**
* This method will reset a specific layout to its original value
* @param id the id of a specific layout
* @returns
*/
reset = async (id: Id) => {
const res = await this.#editorAPI;
return res.resetLayout(id).then((result) => getEditorResponseData<null>(result));
};
/**
* This method will set the height of the layout to a specific value
* @param id the id of a specific layout
* @param height the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
* @returns
*/
setHeight = async (id: Id, height: string) => {
const res = await this.#editorAPI;
return res.setLayoutHeight(id, height).then((result) => getEditorResponseData<null>(result));
};
/**
* This method will set the width of the layout to a specific value
* @param id the id of a specific layout
* @param width the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
* @returns
*/
setWidth = async (id: Id, width: string) => {
const res = await this.#editorAPI;
return res.setLayoutWidth(id, width).then((result) => getEditorResponseData<null>(result));
};
/**
* This method will set the unit of the layout to a specific value
*
* @param id The id of a specific layout
* @param unit the unit that will be used for the layout. All values in this layout will now be reported in this unit
* @returns
*/
setUnit = async (id: Id, unit: MeasurementUnit) => {
const res = await this.#editorAPI;
return res.setLayoutUnit(id, unit).then((result) => getEditorResponseData<null>(result));
};
/**
* This method will reset the height of a specific layout to its original value
* @param id the id of a specific layout
* @returns
*/
resetHeight = async (id: Id) => {
const res = await this.#editorAPI;
return res.resetLayoutHeight(id).then((result) => getEditorResponseData<null>(result));
};
/**
* This method will reset the width of a specific layout to its original value
* @param id the id of a specific layout
* @returns
*/
resetWidth = async (id: Id) => {
const res = await this.#editorAPI;
return res.resetLayoutWidth(id).then((result) => getEditorResponseData<null>(result));
};
/**
* This method will reset the unit of a specific layout to its original (inherited) value
* @param id the id of a specific layout
* @returns
*/
resetUnit = async (id: Id) => {
const res = await this.#editorAPI;
return res.resetLayoutUnit(id).then((result) => getEditorResponseData<null>(result));
};
/**
* @deprecated
* This method returns a UInt8Array containing a PNG encoded image of the currently selected layout.
* This method is deprecated, please use getSnapshot in the PageController
* @returns UInt8Array snapshot of the current layout
*/
getSelectedSnapshot = async () => {
const res = await this.#blobAPI;
return res.getPageSnapshot().then((result) => (result as Uint8Array) ?? (result as EditorResponse<null>));
};
/**
* This method sets the intent of a specific layout. Note that setting the intent for a layout
* can have side-effects such as updating the measurement unit
* @param id the id of a specific layout
* @param intent the intent that will be used for the layout
*/
setIntent = async (id: Id, intent: LayoutIntent) => {
const res = await this.#editorAPI;
return res.setLayoutIntent(id, intent).then((result) => getEditorResponseData<null>(result));
};
/**
* This method resets the intent of a specific layout to its original (inherited) value.
* Note: Calling this on the top layout is not valid
*
* @param id The id of the (child) layout to reset the intent for
*/
resetIntent = async (id: Id) => {
const res = await this.#editorAPI;
return res.resetLayoutIntent(id).then((result) => getEditorResponseData<null>(result));
};
/**
* This method sets the fill color of a specific layout.
* Note: Depending on the layout intent, some colors might not be valid (eg opacity for digitalAnimated, any color for print)
*
* @param id the id of a specific layout
* @param color the color that will be used for the layout
*/
setFillColor = async (id: Id, color: ColorUsage) => {
const res = await this.#editorAPI;
return res.setLayoutFillColor(id, JSON.stringify(color)).then((result) => getEditorResponseData<null>(result));
};
/**
* This is a convenience method to enable or disable the fill color of a specific layout.
* Note: Depending on the layout intent, disabling might not be valid (eg disabling for digitalAnimated)
*
* @param id the id of a specific layout
* @param enabled whether the fill color should be enabled or disabled
*/
setFillColorEnabled = async (id: Id, enabled: boolean) => {
const res = await this.#editorAPI;
return res.setLayoutFillColorEnabled(id, enabled).then((result) => getEditorResponseData<null>(result));
};
/**
* This method resets the fill color of a specific layout to its original (inherited) value.
* Note: Calling this on the top layout is not valid
*
* @param id The id of the (child) layout to reset the fill color for
*/
resetFillColor = async (id: Id) => {
const res = await this.#editorAPI;
return res.resetLayoutFillColor(id).then((result) => getEditorResponseData<null>(result));
};
/**
* This method sets the bleed value of a specific layout.
* Note: this is only valid on a print layout
*
* @param id The id of the specific layout
* @param value The bleed value
* @param position When defined will update the bleed value of a single position,
* otherwise will set all positions to the same value. Depending on this parameter
* being defined, the `areBleedValuesCombined` will also be updated.
*/
setBleedValue = async (id: Id, value: string, position?: PositionEnum) => {
const update: BleedDeltaUpdate = position
? {
left: position === PositionEnum.left ? value : undefined,
top: position === PositionEnum.top ? value : undefined,
right: position === PositionEnum.right ? value : undefined,
bottom: position === PositionEnum.bottom ? value : undefined,
}
: { left: value, top: value, right: value, bottom: value };
const res = await this.#editorAPI;
return res.updateLayoutBleed(id, JSON.stringify(update)).then((result) => getEditorResponseData<null>(result));
};
/**
* This method sets the combined state of the bleed values.
* Note: this is only valid on a print layout
*
* @param id The id of the specific layout
* @param value Whether the bleed values are combined
*/
setAreBleedValuesCombined = async (id: Id, value: boolean) => {
const update: BleedDeltaUpdate = { areBleedValuesCombined: value };
const res = await this.#editorAPI;
return res.updateLayoutBleed(id, JSON.stringify(update)).then((result) => getEditorResponseData<null>(result));
};
/**
* This method will reset the bleed values on the specified layout to its original (inherited) value.
* Note: Calling this on the top layout is not valid.
*
* @param id The id of the (child) layout to reset the bleed values for
*/
resetBleedValues = async (id: Id) => {
const res = await this.#editorAPI;
return res.updateLayoutBleed(id, null).then((result) => getEditorResponseData<null>(result));
};
/**
* Sets the private data for any layout
* @param id the id of the layout to update
* @param privateData the private data
* @returns
*/
setPrivateData = async (id: string, privateData: PrivateData) => {
const res = await this.#editorAPI;
return res
.setLayoutPrivateData(id, JSON.stringify(privateData))
.then((result) => getEditorResponseData<null>(result));
};
/**
* Gets the private data for any layout
* @param id the id of the layout
* @returns the private data
*/
getPrivateData = async (id: string) => {
const res = await this.#editorAPI;
return res.getLayoutPrivateData(id).then((result) => getEditorResponseData<PrivateData>(result));
};
/**
* Sets the display name for any layout
* @param id the id of the layout to update
* @param displayName the display name
* @returns
*/
setDisplayName = async (id: string, displayName: string) => {
const res = await this.#editorAPI;
return res.setLayoutDisplayName(id, displayName).then((result) => getEditorResponseData<null>(result));
};
/**
* Gets the display name for any layout
* @param id the id of the layout
* @returns the display name
*/
getDisplayName = async (id: string) => {
const res = await this.#editorAPI;
return res.getLayoutDisplayName(id).then((result) => getEditorResponseData<string>(result));
};
/**
* Resets the display name for any layout
* @param id the id of the layout to update
* @returns
*/
resetDisplayName = async (id: string) => {
const res = await this.#editorAPI;
return res.setLayoutDisplayName(id, null).then((result) => getEditorResponseData<null>(result));
};
/**
* This method will set the layout availability for end-users
*
* @param id The id of a specific layout
* @param isAvailable whether this layout is available for end-users
* @returns
*/
setAvailableForUser = async (id: Id, isAvailable: boolean) => {
const res = await this.#editorAPI;
return res.setLayoutAvailableForUser(id, isAvailable).then((result) => getEditorResponseData<null>(result));
};
/**
* This method will set the user selected layout
*
* @param id The id of a specific layout
* @param isSelected whether this layout is selected by end-users
* @returns
*/
setSelectedByUser = async (id: Id, isSelected: boolean) => {
const res = await this.#editorAPI;
return res.setLayoutSelectedByUser(id, isSelected).then((result) => getEditorResponseData<null>(result));
};
/**
* This method will set the layout size boundaries for end-users
*
* @param id The id of a specific layout
* @param resizableLayoutProperties the new layout size boundaries
* @returns
*/
setResizableByUser = async (id: Id, resizableLayoutProperties: ResizableLayoutPropertiesUpdate) => {
const res = await this.#editorAPI;
return res
.setLayoutResizableByUser(id, JSON.stringify(resizableLayoutProperties))
.then((result) => getEditorResponseData<null>(result));
};
}
|