Class MeasurementMagnifierPlugin

Hierarchy

RendererPlugin & DisposableManaged & EventBus<Events, this> & Stateful<
StoreApi<RemoveUnderscoredProperties<Store>>,
this,
>
- MeasurementMagnifierPlugin

Implements

AssetRendererPlugin

Index

Constructors

Methods

addDisposable addEventListener dispatchEvent getStore hookInitialize hookRegister? hookTeardown isTornDown setMagnifierSupported setMagnifierVisible toggleMagnifierVisibility

Constructors

constructor

new MeasurementMagnifierPlugin(config: PluginConfig): MeasurementMagnifierPlugin
Parameters
- config: PluginConfig
Returns MeasurementMagnifierPlugin
Overrides Mix( DisposableManaged, Evented<Events>(), Stateful(hidePrivateProperties(measurementMagnifierRenderPluginStore)) ).constructor
- Defined in packages/sdk/annotation/measurement/src/lib/plugin/magnifier/MeasurementMagnifierPlugin.ts:43

Methods

addDisposable

addDisposable(disposable: Disposable): void
Adds the given Disposable to be owned by this plugin.
Parameters
- disposable: Disposable
Returns void
Inherited from Mix( DisposableManaged, Evented<Events>(), Stateful(hidePrivateProperties(measurementMagnifierRenderPluginStore)) ).addDisposable
- Defined in packages/sdk/renderer-plugin/src/lib/mixins/DisposableManaged.ts:44

addEventListener

addEventListener<K extends "onMagnifierVisibilityChanged">(
event: K,
listener: (eventData: Events[K]) => void,
): EventHandle
Adds an event listener for a specific event.
Type Parameters
- K extends "onMagnifierVisibilityChanged"
  The type of the event key.
Parameters
- event: K
  The event to listen to.
- listener: (eventData: Events[K]) => void
  The callback function to be invoked when the event is emitted.
Returns EventHandle
An EventHandle with a remove method to unsubscribe the listener.
Inherited from Mix( DisposableManaged, Evented<Events>(), Stateful(hidePrivateProperties(measurementMagnifierRenderPluginStore)) ).addEventListener
- Defined in packages/sdk/core/src/lib/Event/EventEmitter.ts:28

dispatchEvent

dispatchEvent<K extends "onMagnifierVisibilityChanged">(
...args: DispatchArgsOf<Events, K>,
): void
Dispatches the given event with given payload on the plugin.
Type Parameters
- K extends "onMagnifierVisibilityChanged"
Parameters
- ...args: DispatchArgsOf<Events, K>
Returns void
Inherited from Mix( DisposableManaged, Evented<Events>(), Stateful(hidePrivateProperties(measurementMagnifierRenderPluginStore)) ).dispatchEvent
- Defined in packages/sdk/core/src/lib/Event/EventEmitter.ts:50

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 Mix( DisposableManaged, Evented<Events>(), Stateful(hidePrivateProperties(measurementMagnifierRenderPluginStore)) ).getStore
- Defined in packages/sdk/renderer-plugin/src/lib/mixins/Stateful.ts:24

hookInitialize

hookInitialize(context: AssetRendererPluginContext): void
Called by the plugin system is initialized.
Parameters
- context: AssetRendererPluginContext
  The context provided to the plugin.
Returns void
Implementation of AssetRendererPlugin.hookInitialize
Overrides Mix( DisposableManaged, Evented<Events>(), Stateful(hidePrivateProperties(measurementMagnifierRenderPluginStore)) ).hookInitialize
- Defined in packages/sdk/annotation/measurement/src/lib/plugin/magnifier/MeasurementMagnifierPlugin.ts:47

`Optional`hookRegister

hookRegister?(context: unknown): boolean
Called when the plugin is registered in the system. The result of this hook determines whether the plugin is enabled.
Parameters
- context: unknown
  The context provided to the plugin.
Returns boolean
Whether the plugin should be enabled.
Implementation of AssetRendererPlugin.hookRegister
Inherited from Mix( DisposableManaged, Evented<Events>(), Stateful(hidePrivateProperties(measurementMagnifierRenderPluginStore)) ).hookRegister
- Defined in packages/sdk/renderer-plugin/src/lib/RendererPlugin.ts:9

hookTeardown

hookTeardown(context: AssetRendererPluginContext): void
Called when the plugin system is manually torn down. This should be used to clean up resources.
Parameters
- context: AssetRendererPluginContext
  The context provided to the plugin.
Returns void
Implementation of AssetRendererPlugin.hookTeardown
Overrides Mix( DisposableManaged, Evented<Events>(), Stateful(hidePrivateProperties(measurementMagnifierRenderPluginStore)) ).hookTeardown
- Defined in packages/sdk/annotation/measurement/src/lib/plugin/magnifier/MeasurementMagnifierPlugin.ts:86

isTornDown

isTornDown(): boolean
Checks if the plugin has been torn down.

Returns boolean
true if the plugin has been torn down, otherwise false.
Inherited from Mix( DisposableManaged, Evented<Events>(), Stateful(hidePrivateProperties(measurementMagnifierRenderPluginStore)) ).isTornDown
- Defined in packages/sdk/renderer-plugin/src/lib/mixins/DisposableManaged.ts:39

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
- Defined in packages/sdk/annotation/measurement/src/lib/plugin/magnifier/MeasurementMagnifierPlugin.ts:94

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
- Defined in packages/sdk/annotation/measurement/src/lib/plugin/magnifier/MeasurementMagnifierPlugin.ts:102

toggleMagnifierVisibility

toggleMagnifierVisibility(): void
Returns void
- Defined in packages/sdk/annotation/measurement/src/lib/plugin/magnifier/MeasurementMagnifierPlugin.ts:106

Class MeasurementMagnifierPlugin

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MeasurementMagnifierPlugin

Methods

addDisposable

Parameters

Returns void

addEventListener

Type Parameters

Parameters

Returns EventHandle

dispatchEvent

Type Parameters

Parameters

Returns void

getStore

Returns StoreApi

Deprecated

hookInitialize

Parameters

Returns void

OptionalhookRegister

Parameters

Returns boolean

hookTeardown

Parameters

Returns void

isTornDown

Returns boolean

setMagnifierSupported

Parameters

Returns void

setMagnifierVisible

Parameters

Returns void

toggleMagnifierVisibility

Returns void

Settings

On This Page

`Optional`hookRegister