Interface MeasurementMagnifierPlugin

interface MeasurementMagnifierPlugin {
    getStore(): StoreApi;
    setMagnifierSupported(supported: boolean): void;
    setMagnifierVisible(visible: boolean): void;
}

Hierarchy (View Summary)

MeasurementMagnifierManager
Stateful<StoreApi<RemoveUnderscoredProperties<Store>>>
- MeasurementMagnifierPlugin

Index

Methods

getStore setMagnifierSupported setMagnifierVisible

Methods

getStore

getStore(): StoreApi
The store used by the plugin.

Returns StoreApi
Deprecated
Do not use this directly in user-land code. Either:
- In React code, use the useRendererPluginStore or useRendererPluginStoreLazy hook.
- In non-React code, add methods to mutate the store to the plugin's API instead.
Inherited from Stateful.getStore
- Defined in packages/sdk/renderer-plugin/src/lib/mixins/Stateful.ts:24

setMagnifierSupported

setMagnifierSupported(supported: boolean): void
Set whether the magnifier is supported in the current context. Magnifier visibility depends on support, visibility state, and controller capabilities.
Parameters
- supported: boolean
Returns void
Inherited from MeasurementMagnifierManager.setMagnifierSupported
- Defined in packages/sdk/annotation/measurement/src/lib/plugin/magnifier/MeasurementMagnifierPlugin.ts:10

setMagnifierVisible

setMagnifierVisible(visible: boolean): void
Sets the magnifier visibility. Magnifier will only be visible if supported and the current controller supports magnification.
Parameters
- visible: boolean
Returns void
Inherited from MeasurementMagnifierManager.setMagnifierVisible
- Defined in packages/sdk/annotation/measurement/src/lib/plugin/magnifier/MeasurementMagnifierPlugin.ts:16