Viewport

---

Constructors

new Viewport()

ts

new Viewport(client): Viewport

Parameters

Parameter	Type
client	EditorClient

Returns

Viewport

---

Methods

cancelDraggingNewBlock()

ts

cancelDraggingNewBlock(): void

If startDraggingNewBlock has been called, and the drag-new-block interaction is still active,
cancel that interaction.

Returns

void

---

cancelDraggingNewImage()

ts

cancelDraggingNewImage(): void

If startDraggingNewImage has been called, and the drag-new-image interaction is still active,
cancel that interaction.

Returns

void

---

dragPointerMove()

ts

dragPointerMove(x, y): void

After calling startDraggingNewBlock, call this to simulate the user moving the mouse at the
given location within the top-level browser window.

This has no effect if the drag-new-block interaction is not active.

To convert a position in a Panel's iframe to a position in the top-level browser window,
add the IframeUI.framePosition.

Parameters

Parameter	Type
x	number
y	number

Returns

void

---

dragPointerUp()

ts

dragPointerUp(x, y): void

After calling startDraggingNewBlock, call this to simulate the user releasing the mouse
button at the given location within the top-level browser window.

This has no effect if the drag-new-block interaction is not active.

To convert a position in a Panel's iframe to a position in the top-level browser window,
add the IframeUI.framePosition.

Parameters

Parameter	Type
x	number
y	number

Returns

void

---

findAvailableSpace()

ts

findAvailableSpace(width, height): object

Find available space on the current page for adding new content.

Parameters

Parameter	Type	Description
width	number
height	number

Returns

object

a reference to the page and origin (upper-left point) of the space you can add new
content of the given size to.

page

ts

page: PageProxy;

x

ts

x: number;

y

ts

y: number;

---

focusCameraOnItems()

ts

focusCameraOnItems(items): void

Switch to the page containing these items, if necessary, and then animate the viewport
to zoom in and focus on these items.

Parameters

Parameter	Type	Description
items	ItemProxy[]	The items the camera should zoom to

Returns

void

---

getCurrentPage()

ts

getCurrentPage(): undefined | PageProxy

Returns

undefined | PageProxy

the page currently being viewed

---

getSelectedItems()

ts

getSelectedItems(deep?): ItemProxy[]

Parameters

Parameter	Type	Description
deep?	boolean	If true, and groups are selected, include the contents of those groups in the array

Returns

ItemProxy[]

An array of currently-selected items on the currently-visible page

---

getVisibleRect()

ts

getVisibleRect(): Box

Returns

Box

the box for the current viewport location

---

hookSelection()

ts

hookSelection(callback): string

Parameters

Parameter	Type	Description
callback	(items) => void	Called when the user changes their selection of items

Returns

string

A handle representing this hook, which can be passed to unhookSelection to remove this hook.

---

hookTextEdit()

ts

hookTextEdit(callback, eager?): string

If callback returns false, text editing is prevented.
If callback returns true, text editing continues as normal.

If callback returns a TextEditCompletionCallback(/extension-sdk/#modules_ui_viewport_texteditcompletioncallback),
then text editing is allowed, but that completion callback is called.

when the user finishes editing that text. That completion callback may return true or false to allow or deny the edit, or
also may return a replacement string to use instead of the text the user actually typed. If replacement text is provided,
it will be styled as close to the original as possible, but styles that apply to only parts of the original text will be
discarded.

Parameters

Parameter	Type	Description
callback	(item, textAreaKey, text?) => boolean | TextEditCompletionCallback | Promise<boolean | TextEditCompletionCallback>	Called just before the user starts editing text.
eager?	boolean	Whether to trigger the callback eagerly during text edit

Returns

string

A handle representing this hook, which can be passed to unhookTextEdit to remove this hook.

---

setCurrentPage()

ts

setCurrentPage(page): void

View the given page in the viewport

Parameters

Parameter	Type	Description
page	PageProxy	The page to view

Returns

void

---

setSelectedItems()

ts

setSelectedItems(items): void

Unselect all currently-selected items, and select the subset of the given items that exist on
the currently-visible page.

Parameters

Parameter	Type	Description
items	ItemProxy[]

Returns

void

---

startDraggingNewBlock()

ts

startDraggingNewBlock(definition): Promise<undefined | BlockProxy>

Start an interaction of the current user dragging a new block onto the current page, exactly
as if they started dragging that block out of the normal toolbox. At the time this function is
called, the user's primary mouse button should be down (e.g. in a mousedown event handler).

Parameters

Parameter	Type	Description
definition	BlockDefinition	Definition of the block to create if and where the user drops it on-canvas

Returns

Promise<undefined | BlockProxy>

A promise resolving to a reference to the created block, if successfully dropped,
or undefined if the user cancels the drag interaction.

---

startDraggingNewImage()

ts

startDraggingNewImage(definition): Promise<undefined | BlockProxy>

Start an interaction of the current user dragging a new image onto the current page, exactly
as if they started dragging that image out of the normal toolbox. At the time this function is
called, the user's primary mouse button should be down (e.g. in a mousedown event handler).

Parameters

Parameter	Type	Description
definition	ImageDefinition	Definition of the image to create if and where the user drops it on-canvas

Returns

Promise<undefined | BlockProxy>

A promise resolving to a reference to the created image, if successfully dropped,
or undefined if the user cancels the drag interaction.

---

unhookSelection()

ts

unhookSelection(handle): void

Remove a hook set by hookSelection.

Parameters

Parameter	Type	Description
handle	string	The return value of hookSelection.

Returns

void

---

unhookTextEdit()

ts

unhookTextEdit(handle): void

Remove a hook set by hookTextEdit.

Parameters

Parameter	Type	Description
handle	string	The return value of hookTextEdit.

Returns

void