Selection Plugin

Selection plugin, used in conjunction with the selection action. When used individually, the plugin registers the selection action for each shape.

Types

export type SelectionPluginOptions = {
	selectionActionOptions?: SelectionActionOptions // This property can be passed in pluginOptions['selection'].selectionActionOptions or Selection Plugin instantiation constructor parameters when ImageMark constructs the instance
}

// Selection mode type
export type SelectionType = 'single' | 'multiple'

constructor

// Create a SelectionPlugin instance
constructor(
	imageMarkInstance: ImageMark,
	public selectionPluginOptions?: SelectionPluginOptions
): SelectionPlugin

Static Properties

pluginName

selection

Instance Properties

selectShapeList

List of selected shapes

Instance Methods

getSelectionPluginOptions

// Get plugin configuration
getSelectionPluginOptions(options?: DeepPartial<SelectionPluginOptions>):SelectionPluginOptions

mode

// Switch between single and multiple selection modes
mode(newMode?: SelectionType): void

getSelectionAction

// Get the selection action for a specific shape
getSelectionAction(shape: ImageMarkShape): SelectionAction | undefined

selectShape

// Select a specific shape
selectShape(shape: ImageMarkShape): void

selectShapes

// Select multiple shapes
selectShapes(shapeList: ImageMarkShape[]): void

unselectShape

// Unselect a specific shape
unselectShape(shape: ImageMarkShape): void

unselectShapes

// Unselect multiple shapes
unselectShapes(shapeList: ImageMarkShape[]): void

clear

// Clear all selections
clear(): void

destroy

// Destroy the plugin
destroy(): void