Class SharedInput

An input that can be shared between diagrams and get/set from outside the diagram. You should call useSharedInput to create a shared input, rather than calling new SharedInput directly.

Index

Constructors

Properties

Methods

addEffect get getOptimized register removeEffect set unregister

Constructors

constructor

new SharedInput(init?, optimized?, name?): SharedInput
Parameters
- Optionalinit: number
- optimized: boolean = false
- Optionalname: string
Returns SharedInput
- Defined in bloom/src/core/builder.ts:104

Properties

`Optional` `Readonly`init

init?: number

`Readonly`name

name: string

Methods

addEffect

addEffect(fn): void
Add an effect to run when the value of the input changes.
Parameters
- fn: ((val: number) => void)
  Effect to run
  - - (val): void
    - Parameters
      val: number
      Returns void
Returns void
- Defined in bloom/src/core/builder.ts:128

get

get(): null | number
Get the current value of the input.

Returns null | number
- Defined in bloom/src/core/builder.ts:143

getOptimized

getOptimized(): boolean
Get whether the input is optimized.

Returns boolean
- Defined in bloom/src/core/builder.ts:148

register

register(diagram): void
Parameters
- diagram: Diagram
Returns void
- Defined in bloom/src/core/builder.ts:184

removeEffect

removeEffect(fn): void
Remove an effect added with addEffect from the input.
Parameters
- fn: ((val: number) => void)
  Effect to remove
  - - (val): void
    - Parameters
      val: number
      Returns void
Returns void
- Defined in bloom/src/core/builder.ts:136

set

set(val): void
Set the value of the input. This will update the value in all diagrams, and trigger a re-render for the component that created the input.
Parameters
- val: number
  Value to set the input to
Returns void
- Defined in bloom/src/core/builder.ts:115

unregister

unregister(diagram): void
Parameters
- diagram: Diagram
Returns void
- Defined in bloom/src/core/builder.ts:200