Class TilePlus

The TilePlus class may have instances attached to a Tiles component for additional control and testing methods.

With it you can:

Check or uncheck tiles
Determine the number of inline groups available for a given width.

Hierarchy

SAEventTarget
- TilePlus

Index

Constructors

constructor

new TilePlus(): TilePlus
Returns TilePlus
Inherited from SAEventTarget.constructor

Properties

[EventRecord]

"[EventRecord]": {}

Methods

checkAll

checkAll(): void
Checks all tiles.

Returns void
- Defined in src/components/TilePlus.ts:43

checked

checked(tile: string, value: boolean): void
Sets whether a tile is checked or not.
Parameters
- tile: string
- value: boolean
Returns void
- Defined in src/components/TilePlus.ts:32

emit

emit<
    K extends
        | "setChecked"
        | "checkAll"
        | "uncheckAll"
        | "getInlineGroupsAvailableResult"
        | "getInlineGroupsAvailable",
    C extends new (type: K) => EventResult,
    EventResult extends

            | Event
            | CustomEvent<{ id: string; value: boolean }>
            | CustomEvent<{ requestId: string; width: string }>
            | CustomEvent<{ requestId: string; value: number }>,
>(
    type: K,
    constructor: C,
): boolean
Type Parameters
- K extends
      | "setChecked"
      | "checkAll"
      | "uncheckAll"
      | "getInlineGroupsAvailableResult"
      | "getInlineGroupsAvailable"
- C extends new (type: K) => EventResult
- EventResult extends
      | Event
      | CustomEvent<{ id: string; value: boolean }>
      | CustomEvent<{ requestId: string; width: string }>
      | CustomEvent<{ requestId: string; value: number }>
Parameters
- type: K
- constructor: C
Returns boolean
Inherited from SAEventTarget.emit
- Defined in node_modules/com.sweaxizone.w3c.extension/dist/index.d.ts:28
emit<
    K extends
        | "setChecked"
        | "checkAll"
        | "uncheckAll"
        | "getInlineGroupsAvailableResult"
        | "getInlineGroupsAvailable",
    C extends new (type: K, options: O) => EventResult,
    O,
    EventResult extends

            | Event
            | CustomEvent<{ id: string; value: boolean }>
            | CustomEvent<{ requestId: string; width: string }>
            | CustomEvent<{ requestId: string; value: number }>,
>(
    type: K,
    constructor: C,
    options: O,
): boolean
Type Parameters
- K extends
      | "setChecked"
      | "checkAll"
      | "uncheckAll"
      | "getInlineGroupsAvailableResult"
      | "getInlineGroupsAvailable"
- C extends new (type: K, options: O) => EventResult
- O
- EventResult extends
      | Event
      | CustomEvent<{ id: string; value: boolean }>
      | CustomEvent<{ requestId: string; width: string }>
      | CustomEvent<{ requestId: string; value: number }>
Parameters
- type: K
- constructor: C
- options: O
Returns boolean
Inherited from SAEventTarget.emit
- Defined in node_modules/com.sweaxizone.w3c.extension/dist/index.d.ts:29
emit(event: Event): boolean
Parameters
- event: Event
Returns boolean
Inherited from SAEventTarget.emit
- Defined in node_modules/com.sweaxizone.w3c.extension/dist/index.d.ts:30

inlineGroupsAvailable

inlineGroupsAvailable(width: string): Promise<number>
Returns the number of inline groups available for the given width (either in px or rem).

Note Applies to a vertical layout only.
Parameters
- width: string
Returns Promise<number>
- Defined in src/components/TilePlus.ts:60

off

off<
    K extends
        | "setChecked"
        | "checkAll"
        | "uncheckAll"
        | "getInlineGroupsAvailableResult"
        | "getInlineGroupsAvailable",
>(
    type: K,
    listener: (e: {}[K] extends Event ? any[any] : never) => void | undefined,
    options?: boolean | SAOffEventOptions,
): void
Type Parameters
- K extends
      | "setChecked"
      | "checkAll"
      | "uncheckAll"
      | "getInlineGroupsAvailableResult"
      | "getInlineGroupsAvailable"
Parameters
- type: K
- listener: (e: {}[K] extends Event ? any[any] : never) => void | undefined
- Optionaloptions: boolean | SAOffEventOptions
Returns void
Inherited from SAEventTarget.off
- Defined in node_modules/com.sweaxizone.w3c.extension/dist/index.d.ts:26
off(
    type: string,
    listener: (e: Event) => void | undefined,
    options?: boolean | SAOffEventOptions,
): void
Parameters
- type: string
- listener: (e: Event) => void | undefined
- Optionaloptions: boolean | SAOffEventOptions
Returns void
Inherited from SAEventTarget.off
- Defined in node_modules/com.sweaxizone.w3c.extension/dist/index.d.ts:27

on

on<
    K extends
        | "setChecked"
        | "checkAll"
        | "uncheckAll"
        | "getInlineGroupsAvailableResult"
        | "getInlineGroupsAvailable",
>(
    type: K,
    listener: (e: {}[K] extends Event ? any[any] : never) => void | undefined,
    options?: boolean | SAOnEventOptions,
): void
Type Parameters
- K extends
      | "setChecked"
      | "checkAll"
      | "uncheckAll"
      | "getInlineGroupsAvailableResult"
      | "getInlineGroupsAvailable"
Parameters
- type: K
- listener: (e: {}[K] extends Event ? any[any] : never) => void | undefined
- Optionaloptions: boolean | SAOnEventOptions
Returns void
Inherited from SAEventTarget.on
- Defined in node_modules/com.sweaxizone.w3c.extension/dist/index.d.ts:24
on(
    type: string,
    listener: (e: Event) => void | undefined,
    options?: boolean | SAOnEventOptions,
): void
Parameters
- type: string
- listener: (e: Event) => void | undefined
- Optionaloptions: boolean | SAOnEventOptions
Returns void
Inherited from SAEventTarget.on
- Defined in node_modules/com.sweaxizone.w3c.extension/dist/index.d.ts:25

uncheckAll

uncheckAll(): void
Unchecks all tiles.

Returns void
- Defined in src/components/TilePlus.ts:50

Class TilePlus

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns TilePlus

Properties

[EventRecord]

Methods

checkAll

Returns void

checked

Parameters

Returns void

emit

Type Parameters

Parameters

Returns boolean

Type Parameters

Parameters

Returns boolean

Parameters

Returns boolean

inlineGroupsAvailable

Parameters

Returns Promise<number>

off

Type Parameters

Parameters

Returns void

Parameters

Returns void

on

Type Parameters

Parameters

Returns void

Parameters

Returns void

uncheckAll

Returns void

Settings

On This Page