ImageMarkerEditorController
此内容尚不支持你的语言。
Defined in: packages/editor/src/controller.ts:129
Headless state engine shared by native and Web editor surfaces.
Recipe state, multi-selection, history, clipboard, grouping, alignment, viewport state, and optional autosave live here. Rendering and application design-system choices remain injectable.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ImageMarkerEditorController(
document,historyLimit?):ImageMarkerEditorController
Defined in: packages/editor/src/controller.ts:153
Parameters
Section titled “Parameters”document
Section titled “document”WatermarkRecipeDocument
historyLimit?
Section titled “historyLimit?”number
Returns
Section titled “Returns”ImageMarkerEditorController
Constructor
Section titled “Constructor”new ImageMarkerEditorController(
options):ImageMarkerEditorController
Defined in: packages/editor/src/controller.ts:154
Parameters
Section titled “Parameters”options
Section titled “options”ImageMarkerEditorControllerOptions
Returns
Section titled “Returns”ImageMarkerEditorController
Methods
Section titled “Methods”addLayer()
Section titled “addLayer()”addLayer(
layer,index?):string
Defined in: packages/editor/src/controller.ts:288
Parameters
Section titled “Parameters”WatermarkRecipeLayer
index?
Section titled “index?”number = ...
Returns
Section titled “Returns”string
alignLayers()
Section titled “alignLayers()”alignLayers(
alignment,bounds,canvas?):void
Defined in: packages/editor/src/controller.ts:561
Parameters
Section titled “Parameters”alignment
Section titled “alignment”bounds
Section titled “bounds”readonly EditorLayerBounds[]
canvas?
Section titled “canvas?”height
Section titled “height”number
number
Returns
Section titled “Returns”void
applyTemplate()
Section titled “applyTemplate()”applyTemplate(
template):void
Defined in: packages/editor/src/controller.ts:280
Parameters
Section titled “Parameters”template
Section titled “template”Returns
Section titled “Returns”void
beginHistoryGroup()
Section titled “beginHistoryGroup()”beginHistoryGroup():
void
Defined in: packages/editor/src/controller.ts:204
Returns
Section titled “Returns”void
canPaste()
Section titled “canPaste()”canPaste():
boolean
Defined in: packages/editor/src/controller.ts:662
Returns
Section titled “Returns”boolean
clearAutosave()
Section titled “clearAutosave()”clearAutosave():
Promise<boolean>
Defined in: packages/editor/src/controller.ts:904
Returns
Section titled “Returns”Promise<boolean>
clearSelection()
Section titled “clearSelection()”clearSelection():
void
Defined in: packages/editor/src/controller.ts:248
Returns
Section titled “Returns”void
copyLayers()
Section titled “copyLayers()”copyLayers(
ids?):string
Defined in: packages/editor/src/controller.ts:645
Parameters
Section titled “Parameters”readonly string[] = ...
Returns
Section titled “Returns”string
dispose()
Section titled “dispose()”dispose():
void
Defined in: packages/editor/src/controller.ts:198
Returns
Section titled “Returns”void
distributeLayers()
Section titled “distributeLayers()”distributeLayers(
direction,bounds):void
Defined in: packages/editor/src/controller.ts:601
Parameters
Section titled “Parameters”direction
Section titled “direction”bounds
Section titled “bounds”readonly EditorLayerBounds[]
Returns
Section titled “Returns”void
duplicateLayers()
Section titled “duplicateLayers()”duplicateLayers(
ids?):string[]
Defined in: packages/editor/src/controller.ts:312
Parameters
Section titled “Parameters”readonly string[] = ...
Returns
Section titled “Returns”string[]
endHistoryGroup()
Section titled “endHistoryGroup()”endHistoryGroup():
void
Defined in: packages/editor/src/controller.ts:209
Returns
Section titled “Returns”void
exportRecipe()
Section titled “exportRecipe()”exportRecipe():
WatermarkRecipeDefinition
Defined in: packages/editor/src/controller.ts:284
Returns
Section titled “Returns”WatermarkRecipeDefinition
fitViewport()
Section titled “fitViewport()”fitViewport():
void
Defined in: packages/editor/src/controller.ts:753
Returns
Section titled “Returns”void
flushAutosave()
Section titled “flushAutosave()”flushAutosave():
Promise<boolean>
Defined in: packages/editor/src/controller.ts:896
Returns
Section titled “Returns”Promise<boolean>
getState()
Section titled “getState()”getState():
EditorState
Defined in: packages/editor/src/controller.ts:177
Returns
Section titled “Returns”groupLayers()
Section titled “groupLayers()”groupLayers(
ids?,requestedGroupId?):string
Defined in: packages/editor/src/controller.ts:517
Parameters
Section titled “Parameters”readonly string[] = ...
requestedGroupId?
Section titled “requestedGroupId?”string
Returns
Section titled “Returns”string
handleKeyCommand()
Section titled “handleKeyCommand()”handleKeyCommand(
command):boolean
Defined in: packages/editor/src/controller.ts:762
Parameters
Section titled “Parameters”command
Section titled “command”Returns
Section titled “Returns”boolean
importRecipe()
Section titled “importRecipe()”importRecipe(
document):void
Defined in: packages/editor/src/controller.ts:272
Parameters
Section titled “Parameters”document
Section titled “document”WatermarkRecipeDocument
Returns
Section titled “Returns”void
moveLayer()
Section titled “moveLayer()”moveLayer(
id,point,snapContext?):EditorPoint
Defined in: packages/editor/src/controller.ts:420
Parameters
Section titled “Parameters”string
snapContext?
Section titled “snapContext?”Returns
Section titled “Returns”nudgeLayer()
Section titled “nudgeLayer()”nudgeLayer(
id,delta):void
Defined in: packages/editor/src/controller.ts:449
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
nudgeSelection()
Section titled “nudgeSelection()”nudgeSelection(
delta):void
Defined in: packages/editor/src/controller.ts:457
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
panViewport()
Section titled “panViewport()”panViewport(
delta):void
Defined in: packages/editor/src/controller.ts:741
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
pasteLayers()
Section titled “pasteLayers()”pasteLayers(
serialized?,offset?):string[]
Defined in: packages/editor/src/controller.ts:666
Parameters
Section titled “Parameters”serialized?
Section titled “serialized?”string | EditorClipboardDocument
offset?
Section titled “offset?”EditorPoint = ...
Returns
Section titled “Returns”string[]
patchLayer()
Section titled “patchLayer()”patchLayer(
id,patch):void
Defined in: packages/editor/src/controller.ts:375
Parameters
Section titled “Parameters”string
Partial<WatermarkRecipeDefinitionLayer>
Returns
Section titled “Returns”void
redo()
Section titled “redo()”redo():
boolean
Defined in: packages/editor/src/controller.ts:845
Returns
Section titled “Returns”boolean
removeLayer()
Section titled “removeLayer()”removeLayer(
id?):boolean
Defined in: packages/editor/src/controller.ts:337
Parameters
Section titled “Parameters”string | undefined
Returns
Section titled “Returns”boolean
removeLayers()
Section titled “removeLayers()”removeLayers(
ids?):number
Defined in: packages/editor/src/controller.ts:342
Parameters
Section titled “Parameters”readonly string[] = ...
Returns
Section titled “Returns”number
renameLayer()
Section titled “renameLayer()”renameLayer(
id,name):void
Defined in: packages/editor/src/controller.ts:370
Parameters
Section titled “Parameters”string
string | undefined
Returns
Section titled “Returns”void
reorderLayer()
Section titled “reorderLayer()”reorderLayer(
id,targetIndex):void
Defined in: packages/editor/src/controller.ts:502
Parameters
Section titled “Parameters”string
targetIndex
Section titled “targetIndex”number
Returns
Section titled “Returns”void
replaceImage()
Section titled “replaceImage()”replaceImage(
id,source):void
Defined in: packages/editor/src/controller.ts:411
Parameters
Section titled “Parameters”string
source
Section titled “source”unknown
Returns
Section titled “Returns”void
replaceState()
Section titled “replaceState()”replaceState(
state,recordHistory?):void
Defined in: packages/editor/src/controller.ts:256
Synchronize a controlled Editor state. History capture is opt-in so parent renders do not create undo entries.
Parameters
Section titled “Parameters”recordHistory?
Section titled “recordHistory?”boolean = false
Returns
Section titled “Returns”void
restoreAutosave()
Section titled “restoreAutosave()”restoreAutosave():
Promise<boolean>
Defined in: packages/editor/src/controller.ts:888
Returns
Section titled “Returns”Promise<boolean>
restoreSerializedState()
Section titled “restoreSerializedState()”restoreSerializedState(
serialized):void
Defined in: packages/editor/src/controller.ts:867
Parameters
Section titled “Parameters”serialized
Section titled “serialized”string
Returns
Section titled “Returns”void
rotateLayer()
Section titled “rotateLayer()”rotateLayer(
id,degrees):void
Defined in: packages/editor/src/controller.ts:485
Parameters
Section titled “Parameters”string
degrees
Section titled “degrees”number
Returns
Section titled “Returns”void
scaleLayer()
Section titled “scaleLayer()”scaleLayer(
id,scale):void
Defined in: packages/editor/src/controller.ts:468
Parameters
Section titled “Parameters”string
number
Returns
Section titled “Returns”void
selectAll()
Section titled “selectAll()”selectAll():
void
Defined in: packages/editor/src/controller.ts:243
Returns
Section titled “Returns”void
selectLayer()
Section titled “selectLayer()”selectLayer(
id,mode?):void
Defined in: packages/editor/src/controller.ts:216
Parameters
Section titled “Parameters”string | undefined
EditorSelectionMode = 'replace'
Returns
Section titled “Returns”void
selectLayers()
Section titled “selectLayers()”selectLayers(
ids):void
Defined in: packages/editor/src/controller.ts:237
Parameters
Section titled “Parameters”readonly string[]
Returns
Section titled “Returns”void
serializeState()
Section titled “serializeState()”serializeState():
string
Defined in: packages/editor/src/controller.ts:854
Returns
Section titled “Returns”string
setExportOptions()
Section titled “setExportOptions()”setExportOptions(
options):void
Defined in: packages/editor/src/controller.ts:709
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”void
setLayerLocked()
Section titled “setLayerLocked()”setLayerLocked(
id,locked):void
Defined in: packages/editor/src/controller.ts:361
Parameters
Section titled “Parameters”string
locked
Section titled “locked”boolean
Returns
Section titled “Returns”void
setLayerVisible()
Section titled “setLayerVisible()”setLayerVisible(
id,visible):void
Defined in: packages/editor/src/controller.ts:357
Parameters
Section titled “Parameters”string
visible
Section titled “visible”boolean
Returns
Section titled “Returns”void
setSafeArea()
Section titled “setSafeArea()”setSafeArea(
safeArea):void
Defined in: packages/editor/src/controller.ts:703
Parameters
Section titled “Parameters”safeArea
Section titled “safeArea”Partial<EditorSafeArea>
Returns
Section titled “Returns”void
setViewportZoom()
Section titled “setViewportZoom()”setViewportZoom(
zoom,anchor?):void
Defined in: packages/editor/src/controller.ts:715
Parameters
Section titled “Parameters”number
anchor?
Section titled “anchor?”Returns
Section titled “Returns”void
subscribe()
Section titled “subscribe()”subscribe(
listener): () =>void
Defined in: packages/editor/src/controller.ts:192
Parameters
Section titled “Parameters”listener
Section titled “listener”Listener
Returns
Section titled “Returns”() => void
undo()
Section titled “undo()”undo():
boolean
Defined in: packages/editor/src/controller.ts:836
Returns
Section titled “Returns”boolean
ungroupLayers()
Section titled “ungroupLayers()”ungroupLayers(
ids?):string[]
Defined in: packages/editor/src/controller.ts:536
Parameters
Section titled “Parameters”readonly string[] = ...
Returns
Section titled “Returns”string[]
updateTextLayer()
Section titled “updateTextLayer()”updateTextLayer(
id,patch):void
Defined in: packages/editor/src/controller.ts:396
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
zoomViewportBy()
Section titled “zoomViewportBy()”zoomViewportBy(
factor,anchor?):void
Defined in: packages/editor/src/controller.ts:737
Parameters
Section titled “Parameters”factor
Section titled “factor”number
anchor?
Section titled “anchor?”Returns
Section titled “Returns”void