ScrollFilter <TSource>

Hierarchy

• Filter<ScrollFilterSettings, TSource>
  • ScrollFilter

Index

Constructors

• constructor

Properties

• enabled
• kind
• name
• ref
• settings
• source

Methods

• getDefaultSettings
• remove
• setEnabled
• setSettings

Constructors

constructor

• new ScrollFilter<TSource>(args: CustomFilterArgs<ScrollFilterSettings>): ScrollFilter<TSource>

• Overrides Filter.constructor

  Type parameters

  • TSource: Source<{}, TSource>

  Parameters

  • args: CustomFilterArgs<ScrollFilterSettings>

  Returns ScrollFilter<TSource>

Properties

enabled

enabled: boolean

Inherited from Filter.enabled

kind

kind: string

Inherited from Filter.kind

name

name: string

Inherited from Filter.name

ref

ref: string

Inherited from Filter.ref

settings

settings: { limit_cx?: boolean; limit_cy?: boolean; loop?: boolean; speed_x?: number; speed_y?: number } = ...

Inherited from Filter.settings

Type declaration

• optionallimit_cx?: boolean

• optionallimit_cy?: boolean

• optionalloop?: boolean

• optionalspeed_x?: number

• optionalspeed_y?: number

source

source: TSource

Inherited from Filter.source

Methods

getDefaultSettings

• getDefaultSettings(): Promise<Settings>

• Inherited from Filter.getDefaultSettings

  Returns Promise<Settings>

remove

• remove(): Promise<void>

• Inherited from Filter.remove

  Returns Promise<void>

setEnabled

• setEnabled(enabled: boolean): Promise<void>

• Inherited from Filter.setEnabled

  Parameters

  • enabled: boolean

  Returns Promise<void>

setSettings

• setSettings(settings: { limit_cx?: boolean; limit_cy?: boolean; loop?: boolean; speed_x?: number; speed_y?: number }, overlay?: boolean): Promise<void>

• Inherited from Filter.setSettings

  Parameters

  • settings: { limit_cx?: boolean; limit_cy?: boolean; loop?: boolean; speed_x?: number; speed_y?: number }

  • overlay: boolean = true

  Returns Promise<void>