Class AssetSnapshotRenderPlugin

Hierarchy

RendererPluginBase<Events>
- AssetSnapshotRenderPlugin

Implements

RendererPlugin
StatefulRendererPlugin<StoreApi<Store>>

Index

Constructors

Properties

Methods

addEventListener addManagedListener getStore hookInitialize hookTeardown isTornDown takeSnapshot

Constructors

constructor

new AssetSnapshotRenderPlugin(
context: RendererPluginContext,
): AssetSnapshotRenderPlugin
Parameters
- context: RendererPluginContext
Returns AssetSnapshotRenderPlugin
Overrides RendererPluginBase<Events>.constructor
- Defined in asset/snapshot/src/lib/plugin/AssetSnapshotRenderPlugin.ts:15

Properties

`Protected` `Readonly`emitter

emitter: Emitter<Events> = ...

An event emitter for handling custom events.

Methods

addEventListener

addEventListener<K extends "onActiveChanged">(
event: K,
listener: (eventData: Events[K]) => void,
): { remove: () => void }
Adds an event listener for a specific event.
Type Parameters
- K extends "onActiveChanged"
  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 { remove: () => void }
An object with a remove method to unsubscribe the listener.
Inherited from RendererPluginBase.addEventListener
- Defined in core/src/lib/Event/EventEmitter.ts:35

addManagedListener

addManagedListener(handle: { remove: () => void } | (() => void)): void
Registers an event listener handle to be managed by the plugin. Managed listeners will be automatically removed when the plugin is torn down.
Parameters
- handle: { remove: () => void } | (() => void)
  The event listener handle to manage.
Returns void
Inherited from RendererPluginBase.addManagedListener
- Defined in asset/renderer/src/lib/Plugin/RendererPluginBase.ts:48

getStore

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

Returns StoreApi<Store>
Deprecated
Do not use this directly in user-land code. Either:
- In React code, use the usePluginStore hook.
- In non-React code, add methods to mutate the store to the plugin's API instead.
Implementation of StatefulRendererPlugin.getStore
- Defined in asset/snapshot/src/lib/plugin/AssetSnapshotRenderPlugin.ts:19

hookInitialize

hookInitialize(): void
Called when the renderer is manually initialized. At this point, layer information is not yet available.

Returns void
Implementation of RendererPlugin.hookInitialize
- Defined in asset/snapshot/src/lib/plugin/AssetSnapshotRenderPlugin.ts:23

hookTeardown

hookTeardown(_context: RendererPluginContext): void
Tears down the plugin by removing all managed event listeners and clearing the event emitter. This method is called when the plugin is being destroyed.
Parameters
- _context: RendererPluginContext
  The plugin context provided during teardown.
Returns void
Implementation of RendererPlugin.hookTeardown
Inherited from RendererPluginBase.hookTeardown
- Defined in asset/renderer/src/lib/Plugin/RendererPluginBase.ts:59

`Protected`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 RendererPluginBase.isTornDown
- Defined in asset/renderer/src/lib/Plugin/RendererPluginBase.ts:38

takeSnapshot

takeSnapshot(): Promise<undefined | string>
Returns Promise<undefined | string>
Inherit Doc
- Defined in asset/snapshot/src/lib/plugin/AssetSnapshotRenderPlugin.ts:41