Class ToolController

The ToolController is responsible for all communication regarding the tools. Methods inside this controller can be called by window.SDK.tool.{method-name}

Hierarchy

ToolController

Index

Methods

getSelected setHand setImageFrame setPointer setSelect setShapeEllipse setShapePolygon setShapeRect setTextFrame setTool setZoom

Methods

getSelected

getSelected(): Promise<EditorResponse<ToolType>>
This method returns selected tool

Returns Promise<EditorResponse<ToolType>>
- Defined in controllers/ToolController.ts:34

setHand

setHand(): Promise<EditorResponse<null>>
This method sets the used tool to the Move tool

Returns Promise<EditorResponse<null>>
- Defined in controllers/ToolController.ts:58

setImageFrame

setImageFrame(): Promise<EditorResponse<null>>
This method sets the used tool to the ImageFrame tool

Returns Promise<EditorResponse<null>>
- Defined in controllers/ToolController.ts:79

setPointer

setPointer(): Promise<EditorResponse<null>>
Deprecated
This method sets the used tool to the select tool. This method is deprecated in favour of the setSelect tool setter.

Returns Promise<EditorResponse<null>>
- Defined in controllers/ToolController.ts:44

setSelect

setSelect(): Promise<EditorResponse<null>>
This method sets the used tool to the select tool.

Returns Promise<EditorResponse<null>>
- Defined in controllers/ToolController.ts:51

setShapeEllipse

setShapeEllipse(): Promise<EditorResponse<null>>
This method sets the used tool to the ShapeEllipse tool

Returns Promise<EditorResponse<null>>
- Defined in controllers/ToolController.ts:93

setShapePolygon

setShapePolygon(): Promise<EditorResponse<null>>
This method sets the used tool to the ShapePolygon tool

Returns Promise<EditorResponse<null>>
- Defined in controllers/ToolController.ts:100

setShapeRect

setShapeRect(): Promise<EditorResponse<null>>
This method sets the used tool to the ShapeRectangle tool

Returns Promise<EditorResponse<null>>
- Defined in controllers/ToolController.ts:86

setTextFrame

setTextFrame(): Promise<EditorResponse<null>>
This method sets the used tool to the TextFrame tool

Returns Promise<EditorResponse<null>>
- Defined in controllers/ToolController.ts:72

setTool

setTool(tool: ToolType): Promise<EditorResponse<null>>
This method sets the currently used tool
Parameters
- tool: ToolType
Returns Promise<EditorResponse<null>>
- Defined in controllers/ToolController.ts:26

setZoom

setZoom(): Promise<EditorResponse<null>>
This method sets the used tool to the Zoom tool

Returns Promise<EditorResponse<null>>
- Defined in controllers/ToolController.ts:65

Generated using TypeDoc