FloatingToolbarManager

Enumerations

FloatingToolbarMode

Floating Toolbar modes.

Enumeration Members

Enumeration Member	Value	Description
Classic	"Classic"	Displays the toolbar on the canvas regardless of user hover.
Inside	"Inside"	Displays the toolbar on top of images and image placeholders when the user hovers over the item.

Classes

FloatingToolbarManager

Constructors

Constructor

new FloatingToolbarManager(
   canvasElementHandler,
   viewer,
   canvas,
   selectionHandler,
   config?): FloatingToolbarManager;

Parameters

Parameter	Type
canvasElementHandler	CanvasElementHandler
viewer	Viewer
canvas	Canvas
selectionHandler	SelectionHandler
config?	IFloatingItemToolbarConfig

Returns

FloatingToolbarManager

Accessors

configuration

Set Signature

set configuration(conf): void;

Parameters

Parameter	Type
conf	IFloatingItemToolbarConfig

Returns

void

enabled

Get Signature

get enabled(): boolean;

Returns

boolean

Set Signature

set enabled(v): void;

Parameters

Parameter	Type
v	boolean

Returns

void

eventManager

Set Signature

set eventManager(eventManager): void;

Parameters

Parameter	Type
eventManager	EventManager

Returns

void

Methods

dispose()

dispose(): void;

Returns

void

Interfaces

IFloatingItemToolbarConfig

A structure defining appearance of the Floating Item Toolbar.

Example

configuration = {
  canvas: {
    floatingToolbar: {
      enabled: true,
      mode: "Inside",
      buttons: ["Handle", "Select", "Edit"],
    },
  },
};

Properties

bigButtonCssClass?

optional bigButtonCssClass?: string;

CSS class for big buttons in the toolbar.

buttons?

optional buttons?: FloatingToolbarButton[];

Array of buttons for the toolbar. The default buttons are ["Select", "Edit", "Delete"].

cssClass?

optional cssClass?: string;

CSS class to apply to the Floating Item toolbar.

deleteButtonClass?

optional deleteButtonClass?: string;

CSS class for the Delete button.

editButtonClass?

optional editButtonClass?: string;

CSS class for the Edit button.

enabled?

optional enabled?: boolean;

If true, displays the floating item toolbar. The default value is true.

handleButtonClass?

optional handleButtonClass?: string;

CSS class for the Handle button.

mode?

optional mode?: FloatingToolbarMode;

Specifies the mode of the Floating Item Toolbar. The default value is FloatingToolbarMode.Classic.

selectButtonClass?

optional selectButtonClass?: string;

CSS class for the Select button.

Type Aliases

FloatingToolbarButton

type FloatingToolbarButton = "Handle" | "Select" | "Edit" | "Delete";