Class default

Hierarchy

Constructors

constructor

Properties

attributes body classes data edges entered event hasHiddenClass? header id internalDialog log noticeRowsHidden observing? removed? rooted rows scrollableHandler sectionHidden sectionNotUnlockableInMode sectionUnlockableInMode sectionUnlocked sortFilterRow style map

Accessors

childCount dataset element footer selectable square subId

Methods

addClasses addEventListener addPanel addScrollableWrapper addSettingsPanel append appendTo canSetTitle close closest contains deregisterBindHandlers deregisterEventBusSubscriber dump exists focus furthest getAs getBindable getBox getChildren getDataHostId getDefaultSort getDialog getFilterString getHiddenCount getHighlight getHighlightSelector getIcon getIndex getMenu getName getNthChild getNthChildFromEnd getOffset getOppositeEdgePosition getPanel getParent getPlayerTitleType getProgress getRectangle getReferenceType getScreen getSectionComponent getSelectionTarget getSiblingDialogs getSortEnum getUnlockableSection getUnlockableTranslator getUnlockables getUnlockablesName hide intersectsWithSiblings isActive isFocused isPanelVisible isPinned isPositionFree isSelectable isShowingTooltip isVisible markActive markInactive matches observe onAppend onContextMenu onDialogMoveResize onEnter onLeave onPlayerChangeTitle onRemove1 onSelect onTickEnd pin prepend prependTo querySelectorAll queryX queryXAll reflow refreshTooltip refreshUnlockable regenerateBoxes registerBindHandlers registerEventBusSubscriber remove removeEventListener removeTooltip repaint resetSizeAndPosition resolveEdges schedule scrollTo setContents setContextMenu setEdgePosition setElement setHighlight setId setInert setInitialSelection setSelectable setSizeAndPosition setTooltip shouldShowUnlockable show showPanel showSettingsPanel showTooltip siblings sleep sortUnlockables store tempHighlight toggle toggleActive togglePinned translateSort unpin updateSkill all append findDescendants get getSelectableLayer makeTopDialog remove

Constructors

constructor

Properties

Readonly attributes

attributes: AttributeManipulator<default>

Protected Readonly body

body: default<HTMLElement>

Readonly classes

classes: ClassManipulator<default>

Readonly data

data: DataManipulator<default>

edges

edges: IDialogEdges = ...

The positions of each edge of the dialog. Stored as percentages.

Protected entered

entered: boolean = false

event

event: IEventEmitter<default, IDialogEvents>

Protected Optional hasHiddenClass

hasHiddenClass?: boolean

Protected Readonly header

header: Header

Readonly id

id: DialogId

Protected Readonly internalDialog

internalDialog: default<HTMLElement>

Readonly log

log: Log

Readonly noticeRowsHidden

noticeRowsHidden: Paragraph

Optional observing

observing?: boolean

Optional removed

removed?: string | boolean

rooted

rooted: boolean = false

Readonly rows

rows: Map<SkillType, default>

Protected Readonly scrollableHandler

scrollableHandler: void = ...

Readonly sectionHidden

sectionHidden: default<HTMLElement>

Readonly sectionNotUnlockableInMode

sectionNotUnlockableInMode: default<HTMLElement>

Readonly sectionUnlockableInMode

sectionUnlockableInMode: default<HTMLElement>

Readonly sectionUnlocked

sectionUnlocked: default<HTMLElement>

Readonly sortFilterRow

sortFilterRow: default<SkillSort>

Readonly style

style: StyleManipulator<default>

Static map

map: WeakMap<Element, default<HTMLElement>> = componentMap

Accessors

childCount

  • get childCount(): number

  • The number of child elements of this component.

    Returns number

dataset

  • get dataset(): DOMStringMap

  • The dataset of the internal element.

    Returns DOMStringMap

element

  • get element(): E

  • The element that this Component instance wraps.

    Returns E

Protected footer

  • get footer(): Footer

  • Returns Footer

selectable

  • get selectable(): false | SelectableLayer

  • The selectable layer of this element, or false if it is not selectable.

    Returns false | SelectableLayer

square

  • get square(): boolean

  • Returns boolean

subId

  • get subId(): string

  • Returns string

  • set subId(value: string): void

  • Parameters

    • value: string

    Returns void

Methods

addClasses

  • Parameters

    Returns void

addEventListener

  • Alias of .element.addEventListener, except it returns this instead and prevents memory leaks

    Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any)
        • (this: HTMLElement, ev: HTMLElementEventMap[K]): any

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns default

  • Parameters

    • type: string
    • listener: ((this: HTMLElement, ev: Event) => any)
        • (this: HTMLElement, ev: Event): any

        • Parameters

          • this: HTMLElement
          • ev: Event

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns default

addPanel

  • Parameters

    • id: string | number

    Returns default<HTMLElement>

addScrollableWrapper

  • Parameters

    • type: "scroll" | "auto" = "scroll"
    • Optional initializer: ((wrapper: default<HTMLElement>) => any)
        • (wrapper: default<HTMLElement>): any

        • Parameters

          Returns any

    Returns default<HTMLElement>

addSettingsPanel

append

  • Appends every element of a list of components/elements.

    Parameters

    • Rest ...elements: ArrayOfIterablesOr<undefined | false | HTMLElement | default<HTMLElement>>

      A varargs list of elements or iterables of elements. Falsy values are skipped

    Returns default

  • Appends every element of a list of components/elements.

    Parameters

    • appendStrategy: AppendStrategy

      Where in this component to insert new components. See AppendStrategy

    • Rest ...elements: ArrayOfIterablesOr<undefined | false | HTMLElement | default<HTMLElement>>

      A varargs list of elements or iterables of elements. Falsy values are skipped

    Returns default

appendTo

  • Appends this component to another element, by selector, element, or component.

    Parameters

    • Optional where: null | string | HTMLElement | default<HTMLElement>

      A CSS selector, an element, or a component to append this component to.

    • Optional appendStrategy: AppendStrategy

      Where in the new container to insert this component. See AppendStrategy

    Returns default

Protected canSetTitle

  • Parameters

    Returns boolean

close

  • Closes the dialog.

    Also the event handler for when the close button is pressed in the dialog's header.

    Returns Promise<boolean>

closest

  • An alias for element.closest(selector)

    Parameters

    • selector: string

    Returns undefined | Element

contains

  • Returns whether this component contains the given element.

    Parameters

    • Optional what: null | string | Node | default<HTMLElement>

    Returns boolean

deregisterBindHandlers

deregisterEventBusSubscriber

dump

  • Removes all children.

    Returns default

  • Removes all children that are not filtered out with the given filter function.

    Parameters

    • Optional filter: ((element: HTMLElement, component?: default<HTMLElement>) => boolean)

      A function that returns true if the child should be kept.

        • (element: HTMLElement, component?: default<HTMLElement>): boolean

        • Parameters

          • element: HTMLElement
          • Optional component: default<HTMLElement>

          Returns boolean

    Returns default

exists

  • Returns boolean

focus

  • Makes this dialog the top dialog.

    Returns void

furthest

  • An alias for element.closest(selector)

    Parameters

    • selector: string

    Returns undefined | HTMLElement

getAs

  • Type Parameters

    Parameters

    • cls: AnyClass<C>

    Returns undefined | C

getBindable

getBox

  • A cached alias for element.getBoundingClientRect(). Boxes are updated or regenerated as ancestors shift.

    Parameters

    • regenIfZero: boolean = true
    • forceRegen: boolean = false

    Returns default

getChildren

  • Returns a stream of this component's child components. Child elements that don't have associated components will be undefined.

    Type Parameters

    Parameters

    • Optional selector: string

      A selector that each element must match to be included in the result stream

    Returns Stream<C>

Protected getDataHostId

  • Returns string

Protected getDefaultSort

getDialog

  • Returns this component's containing dialog, if it exists.

    Type Parameters

    Returns undefined | D

Protected getFilterString

Protected getHiddenCount

  • Returns number

Protected getHighlight

Protected getHighlightSelector

getIcon

getIndex

  • Returns the index of this component amongst its sibling nodes. If it has no parent, it returns undefined.

    Parameters

    • elementsOnly: boolean = false

    Returns undefined | number

getMenu

  • Returns this component's containing menu, if it exists.

    Type Parameters

    Returns undefined | M

getName

getNthChild

  • Returns the nth child, defaulting to the first child

    Type Parameters

    • C extends undefined | default<HTMLElement> = undefined | default<HTMLElement>

    Parameters

    • nth: number = 0

    Returns undefined | C

getNthChildFromEnd

  • Returns the nth child from the end, defaulting to the last child

    Type Parameters

    • C extends undefined | default<HTMLElement> = undefined | default<HTMLElement>

    Parameters

    • nth: number = 0

    Returns undefined | C

getOffset

  • Returns an object containing HTMLElement.offsetTop and HTMLElement.offsetLeft

    Returns {
        left: number;
        top: number;
    }

    • left: number
    • top: number

Protected getOppositeEdgePosition

  • Parameters

    • edge: Edge
    • position: number

    Returns number

getPanel

  • Parameters

    • id: string | number

    Returns undefined | default<HTMLElement>

getParent

  • Returns this component's parent component, if it exists.

    Type Parameters

    • C extends undefined | default<HTMLElement> = undefined | default<HTMLElement>

    Returns null | C

Protected getPlayerTitleType

Protected getProgress

  • Parameters

    Returns number

getRectangle

Protected getReferenceType

getScreen

  • Returns this component's containing dialog, if it exists.

    Type Parameters

    Returns undefined | S

Protected getSectionComponent

getSelectionTarget

Protected getSiblingDialogs

Protected getSortEnum

Protected getUnlockableSection

Protected getUnlockableTranslator

Protected getUnlockables

Protected getUnlockablesName

hide

  • Hides the element. If a tooltip is shown for this element, hides that as well.

    Parameters

    • trustInternalState: boolean = false

    Returns default

Protected intersectsWithSiblings

isActive

  • Returns boolean

isFocused

  • Returns boolean

isPanelVisible

  • Parameters

    • id: string | number

    Returns boolean

isPinned

  • Returns boolean

Protected isPositionFree

isSelectable

  • Returns boolean

isShowingTooltip

  • Returns boolean

isVisible

  • Returns whether the element is visible.

    Parameters

    • trustInternalState: boolean = false

    Returns boolean

markActive

  • Mark that this dialog is "active"

    Parameters

    • reason: any

    Returns void

markInactive

  • Mark that this dialog is not "active"

    Parameters

    • reason: any

    Returns void

matches

  • Parameters

    • selector: string

    Returns boolean

observe

  • Enables a intersection observe on this component and fires an observe event once when the element is first observed

    Returns void

Protected onAppend

  • Event handler for when this dialog is appended

    Returns void

Protected onContextMenu

Protected onDialogMoveResize

  • Returns void

Protected onEnter

  • Parameters

    • reason: "focus" | "mouse"

    Returns void

Protected onLeave

  • Parameters

    • reason: "remove" | "focus" | "mouse"

    Returns void

onPlayerChangeTitle

  • Parameters

    Returns void

Protected onRemove1

  • Returns void

Protected onSelect

  • Parameters

    • _: any
    • Optional component: default<HTMLElement>

    Returns void

Protected onTickEnd

  • Returns void

pin

  • Mark that this dialog is forced to be the top dialog

    Parameters

    • reason: any

    Returns void

prepend

  • Appends every element of a list of components/elements.

    Parameters

    • Rest ...elements: ArrayOfIterablesOr<undefined | false | HTMLElement | default<HTMLElement>>

      A varargs list of elements or iterables of elements. Falsy values are skipped

    Returns default

prependTo

  • Appends this component to another element, by selector, element, or component.

    Parameters

    • Optional where: null | string | HTMLElement | default<HTMLElement>

      A CSS selector, an element, or a component to append this component to.

    Returns default

querySelectorAll

  • An alias for element.querySelectorAll(selector)

    Type Parameters

    • E extends HTMLElement<E> = HTMLElement

    Parameters

    • selector: string

    Returns NodeListOf<E>

queryX

  • Type Parameters

    • N extends Node<N> = Node

    Parameters

    • selector: string

    Returns null | N

queryXAll

  • Type Parameters

    • N extends Node<N> = Node

    Parameters

    • selector: string

    Returns N[]

reflow

  • Parameters

    • reason: string

    Returns void

refreshTooltip

  • Returns void

Protected refreshUnlockable

  • Parameters

    Returns void

regenerateBoxes

  • Forcibly regenerates the cached result of Component.getBox for this component and all descendants.

    Parameters

    • descendants: boolean = true

    Returns void

registerBindHandlers

  • Parameters

    • Rest ...untilEvents: (keyof IDialogEvents)[]

    Returns void

  • Parameters

    • warnIfNoHandlers: false
    • Rest ...untilEvents: (keyof IDialogEvents)[]

    Returns void

registerEventBusSubscriber

  • Parameters

    • Rest ...untilEvents: (keyof IDialogEvents)[]

    Returns void

remove

  • Removes this element and all descendants.

    Returns default

removeEventListener

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any)
        • (this: HTMLElement, ev: HTMLElementEventMap[K]): any

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    Returns default

removeTooltip

  • Returns void

repaint

  • Triggers a repaint on this element.

    Returns void

resetSizeAndPosition

  • Returns void

Protected resolveEdges

schedule

  • Runs the given callback with the given arguments. this and the first argument are this element.

    Type Parameters

    • A extends any[]

    Parameters

    • Optional cb: ((this: default, component: default, ...args: A) => any)

      The callback to run.

    • Rest ...args: A

      The arguments with which to call the callback.

    Returns default

  • Runs the given callback with the given arguments. this and the first argument are this element.

    Parameters

    • Optional cb: ((this: default, component: default) => any)

      The callback to run.

    • Rest ...args: any[]

      The arguments with which to call the callback.

    Returns default

  • Runs the given callback with the given arguments, after the specified amount of time. this and the first argument are this element.

    Type Parameters

    • A extends any[]

    Parameters

    • ms: number

      The amount of time to wait before running the callback, in milliseconds.

    • cb: ((this: default, component: default, ...args: A) => any)

      The callback to run.

    • Rest ...args: A

      The arguments with which to call the callback.

    Returns default

  • Runs the given callback with the given arguments, after the specified amount of time. this and the first argument are this element.

    Parameters

    • ms: number

      The amount of time to wait before running the callback, in milliseconds.

    • Optional cb: ((this: default, component: default) => any)

      The callback to run.

    • Rest ...args: any[]

      The arguments with which to call the callback.

    Returns default

  • Runs the given callback with the given arguments, after the specified amount of time. this and the first argument are this element.

    Type Parameters

    • A extends any[]

    Parameters

    • ms: number

      The amount of time to wait before running the callback, in milliseconds.

    • debounce: number

      The span of time to debounce in. (If this callback was scheduled again in this time, skip this earlier call)

    • cb: ((this: default, component: default, ...args: A) => any)

      The callback to run.

    • Rest ...args: A

      The arguments with which to call the callback.

    Returns default

  • Runs the given callback with the given arguments, after the specified amount of time. this and the first argument are this element.

    Parameters

    • ms: number

      The amount of time to wait before running the callback, in milliseconds.

    • debounce: number

      The span of time to debounce in. (If this callback was scheduled again in this time, skip this earlier call)

    • Optional cb: ((this: default, component: default) => any)

      The callback to run.

    • Rest ...args: any[]

      The arguments with which to call the callback.

    Returns default

scrollTo

  • Scrolls this element so the given child is at the top of the viewport.

    Parameters

    • Optional child: HTMLElement | default<HTMLElement>

      The child to scroll to

    • Optional ms: number

      The time to take, defaulting to 1000 (1 second)

    Returns void

  • Scrolls this element so the given child is at the top of the viewport.

    Parameters

    • child: undefined | HTMLElement | default<HTMLElement>

      The child to scroll to

    • offsetTop: number

      An offset for the position to scroll to, relative to the position of the child

    • Optional ms: number

      The time to take, defaulting to 1000 (1 second)

    Returns void

setContents

  • Sets the contents of this element using innerHTML.

    Parameters

    • html: string

      The content, an HTML string. Script tags will not be executed, as per the normal functionality of innerHTML

    • escape: boolean = false

      Only the text within the HTML will be appended, not the tags.

    Returns default

setContextMenu

  • Removes the context menu from this element.

    Returns default

  • Sets the context menu for this element.

    Parameters

    • generator: ((contextMenu: ContextMenu, api: IBindHandlerApi) => undefined | ContextMenu)
        • (contextMenu: ContextMenu, api: IBindHandlerApi): undefined | ContextMenu

        • Parameters

          Returns undefined | ContextMenu

    • Optional priority: number

    Returns default

setEdgePosition

  • Set the position of an edge.

    Parameters

    • edge: Edge
    • position: number
    • transform: boolean = true

    Returns void

setElement

  • Warning: This method will replace the internal element backing this component.

    Only call this directly after constructing the element.

    Parameters

    • element: HTMLElement

    Returns default

  • Warning: This method will replace the internal element backing this component.

    Only call this directly after constructing the element.

    Parameters

    • Optional elementType: string
    • Optional namespace: SVG

    Returns default

setHighlight

setId

  • Sets the ID of this component's element.

    Parameters

    • id: string

    Returns default

setInert

  • Parameters

    • inert: boolean = true

    Returns default

setInitialSelection

  • Parameters

    • initialSelection: boolean = true

    Returns default

setSelectable

setSizeAndPosition

setTooltip

  • Sets the tooltip options for this element. Setting the tooltip to undefined, or not providing the argument removes the tooltip options.

    Type Parameters

    • ARGS extends any[]

    Parameters

    • Optional initializer: ((tooltip: default, ...args: ARGS) => any)
        • (tooltip: default, ...args: ARGS): any

        • Parameters

          • tooltip: default
          • Rest ...args: ARGS

          Returns any

    • Rest ...args: ARGS

    Returns default

Protected shouldShowUnlockable

  • Parameters

    Returns boolean

show

  • Shows the element.

    Parameters

    • trustInternalState: boolean = false

    Returns default

showPanel

  • Parameters

    • id: string | number
    • Optional disableAnimations: boolean

    Returns undefined | default<HTMLElement>

showSettingsPanel

showTooltip

  • Returns void

siblings

  • Returns a stream of this component's sibling components. Child elements that don't have associated components will be undefined.

    Type Parameters

    Parameters

    • Optional selector: string

      A selector that each element must match to be included in the result stream

    Returns Stream<C>

sleep

  • Returns

    a promise that resolves when either the given time has passed, or this component has been removed. Returns true if this component exists, false if it has been removed.

    Parameters

    • ms: number

    Returns Promise<boolean>

Protected sortUnlockables

store

  • Moves this element to a hidden element, in order to retain any information the element had. This allows the element to be re-appended later without re-adding event handlers, CSS, or any other data.

    Parameters

    Returns default

tempHighlight

  • Parameters

    • duration: number = 5000

    Returns void

toggle

  • Toggles the visibility of this element. Internally uses show and hide.

    Parameters

    • Optional visible: boolean

      The new visiblity of this element.

    • trustInternalState: boolean = false

    Returns default

toggleActive

  • Toggle whether this dialog is "active"

    Parameters

    • reason: any
    • active: boolean

    Returns void

togglePinned

  • Toggle whether this dialog is forced to be the top dialog

    Parameters

    • reason: any
    • pinned: boolean

    Returns void

Protected translateSort

unpin

  • Mark that this dialog is forced to be the top dialog

    Parameters

    • reason: any

    Returns void

Protected updateSkill

  • Parameters

    Returns void

Static all

  • Parameters

    • selector: string

    Returns Stream<default<HTMLElement>>

Static append

  • Parameters

    • elementToMove: string | HTMLElement | default<HTMLElement>
    • placeToAppendTo: string | HTMLElement | default<HTMLElement>
    • strategy: AppendStrategy = "append"

    Returns void

Static findDescendants

  • Parameters

    • inElement: HTMLElement | default<HTMLElement>
    • selector: string
    • includeSelf: boolean = false

    Returns HTMLElement[]

Static get

  • Parameters

    • selector: string

    Returns undefined | default<HTMLElement>

  • Parameters

    • element: Element | default<HTMLElement>

    Returns default<HTMLElement>

  • Parameters

    • event: Event

    Returns default<HTMLElement>

  • Parameters

    • element: undefined | null | false | Element | default<HTMLElement>

    Returns undefined | default<HTMLElement>

  • Parameters

    • selector: string
    • create: undefined | false

    Returns undefined | default<HTMLElement>

  • Parameters

    • element: Element | default<HTMLElement>
    • create: undefined | false

    Returns undefined | default<HTMLElement>

  • Parameters

    • event: Event
    • create: undefined | false

    Returns undefined | default<HTMLElement>

  • Parameters

    • element: undefined | null | false | Element | default<HTMLElement>
    • create: undefined | false

    Returns undefined | default<HTMLElement>

  • Type Parameters

    Parameters

    • selector: string

    Returns undefined | C

  • Type Parameters

    Parameters

    • element: Element | C

    Returns C

  • Type Parameters

    Parameters

    • event: Event

    Returns C

  • Type Parameters

    Parameters

    • element: undefined | null | false | Element | C

    Returns undefined | C

  • Type Parameters

    Parameters

    • selector: string
    • create: undefined | false

    Returns undefined | C

  • Type Parameters

    Parameters

    • element: Element | C
    • create: undefined | false

    Returns undefined | C

  • Type Parameters

    Parameters

    • event: Event
    • create: undefined | false

    Returns undefined | C

  • Type Parameters

    Parameters

    • element: undefined | null | false | Element | C
    • create: undefined | false

    Returns undefined | C

Static getSelectableLayer

  • Parameters

    • element: HTMLElement | default<HTMLElement>

    Returns number | false

Static makeTopDialog

  • Parameters

    • element: HTMLElement

    Returns void

Static remove

  • Parameters

    • elementToRemove: null | string | Element | default<HTMLElement> | ChildNode
    • force: boolean = false
    • uncacheSiblingsAndAncestors: boolean = true

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc