Class LabelTestApi

Implements

IHasTestFocusEvents

Implements

IFocusableTest

Implements

IUpdateablePropertyTest

Hierarchy (view full)

TestApi
- LabelTestApi

Implements

Index

Properties

scriptId testType

Methods

focus getProperties onFocusIn onFocusOut updateProperties

Properties

scriptId

scriptId: string

testType

testType: InspectionTest

Methods

focus

focus(): Promise<void>
Moves the focus to this test. This does nothing if the test is not in the currently-running sub-inspection or the global tag area.

Returns Promise<void>
Implementation of IFocusableTest.focus

getProperties

getProperties(): Promise<LabelTestWorkerGet>
Gets the test's properties

Returns Promise<LabelTestWorkerGet>
Implementation of IUpdateablePropertyTest.getProperties

onFocusIn

onFocusIn(fn): ScriptEventSubscription
Bind a function to fire after a test gained focus.
Parameters
- fn: ((event: TestScriptEvent) => void)
  The function to fire.
  - - (event): void
    - Parameters
      event: TestScriptEvent
      Returns void
Returns ScriptEventSubscription
ScriptEventSubscription

Implementation of IHasTestFocusEvents.onFocusIn

onFocusOut

onFocusOut(fn): ScriptEventSubscription
Bind a function to fire after a test lost focus.
Parameters
- fn: ((event: TestFocusOutScriptEvent) => void)
  The function to fire.
  - - (event): void
    - Parameters
      event: TestFocusOutScriptEvent
      Returns void
Returns ScriptEventSubscription
ScriptEventSubscription

Implementation of IHasTestFocusEvents.onFocusOut

updateProperties

updateProperties(newProps): Promise<any>
Updates the test with new values.
Parameters
- newProps: LabelTestWorkerUpdate
  Object with new properties to use
Returns Promise<any>
Implementation of IUpdateablePropertyTest.updateProperties