Class VisibilityController

The VisibilityController class is used to control the visibility of anything that can be hidden or shown.

Aracna Reference

Index

Constructors

Properties

Accessors

hasHidden hasHiding hasShowing hasVisible HIDDEN HIDING SHOWING VISIBLE

Methods

clear get hide isHidden isHiding isShowing isVisible show toggle

Constructors

constructor

new VisibilityController(): VisibilityController
Returns VisibilityController

Properties

`Protected` `Readonly`data

data: Map<string, string> = ...

Accessors

hasHidden

get hasHidden(): boolean
Checks if any entity is hidden.

Returns boolean
- Defined in src/classes/visibility-controller.ts:110

hasHiding

get hasHiding(): boolean
Checks if any entity is hiding.

Returns boolean
- Defined in src/classes/visibility-controller.ts:117

hasShowing

get hasShowing(): boolean
Checks if any entity is showing.

Returns boolean
- Defined in src/classes/visibility-controller.ts:124

hasVisible

get hasVisible(): boolean
Checks if any entity is visible.

Returns boolean
- Defined in src/classes/visibility-controller.ts:131

`Protected` `Static`HIDDEN

get HIDDEN(): string
Returns string
- Defined in src/classes/visibility-controller.ts:135

`Protected` `Static`HIDING

get HIDING(): string
Returns string
- Defined in src/classes/visibility-controller.ts:139

`Protected` `Static`SHOWING

get SHOWING(): string
Returns string
- Defined in src/classes/visibility-controller.ts:143

`Protected` `Static`VISIBLE

get VISIBLE(): string
Returns string
- Defined in src/classes/visibility-controller.ts:147

Methods

clear

clear(): void
Clears the visibility of all entities.

Returns void
- Defined in src/classes/visibility-controller.ts:70

`Protected`get

get(name: string): string
Parameters
- name: string
Returns string
- Defined in src/classes/visibility-controller.ts:75

hide

hide(name: string, delay?: number): Promise<void>
Hides the entity with the given name. Optionally a delay can be set.
Parameters
- name: string
- delay: number = 0
Returns Promise<void>
- Defined in src/classes/visibility-controller.ts:17

isHidden

isHidden(name: string): boolean
Checks if the entity with the given name is hidden.
Parameters
- name: string
Returns boolean
- Defined in src/classes/visibility-controller.ts:82

isHiding

isHiding(name: string): boolean
Checks if the entity with the given name is hiding.
Parameters
- name: string
Returns boolean
- Defined in src/classes/visibility-controller.ts:89

isShowing

isShowing(name: string): boolean
Checks if the entity with the given name is showing.
Parameters
- name: string
Returns boolean
- Defined in src/classes/visibility-controller.ts:96

isVisible

isVisible(name: string): boolean
Checks if the entity with the given name is visible.
Parameters
- name: string
Returns boolean
- Defined in src/classes/visibility-controller.ts:103

show

show(name: string, delay?: number): Promise<void>
Shows the entity with the given name. Optionally a delay can be set.
Parameters
- name: string
- delay: number = 0
Returns Promise<void>
- Defined in src/classes/visibility-controller.ts:37

toggle

toggle(name: string, delay?: VisibilityControllerToggleDelay): Promise<void>
Toggles the entity with the given name. Optionally a delay can be set, which can be different for hiding and showing.
Parameters
- name: string
- delay: VisibilityControllerToggleDelay = 0
Returns Promise<void>
- Defined in src/classes/visibility-controller.ts:57