Class default

Hierarchy

Constructors

constructor

Properties

actualViewAngle actualViewOffset actualViewScale actualViewZoom attributes body buttonSurface canZoom canvas classes closeOnTravel data drawer edges entered event header id info internalDialog lastSailAwayCheckPosition? loading log mainPanel observing? ports portsWrapper removed? scrollableHandler selectedIslandPosition style subId title uiSurface viewAngle viewOffset viewScale viewZoom zoomReference

Accessors

childCount dataset element footer isHovering island selectable square

Methods

addEventListener addPanel addScrollableWrapper addSettingsPanel append appendTo canHideDrawer close closest contains createExecuteButton deregisterBindHandlers deregisterEventBusSubscriber draw dump exists findDescendants flipHorizontal flipVertical focus getAs getBindable getBox getChildren getClosestDialog getDialog getIcon getIndex getMenu getMousePosition getName getNthChild getOffset getPanel getParent getScreen getSelectionTarget hide initializeSettingsPanel isActive isDragging isFocused isPanelVisible isPlayerSwimming isSelectable isSelectedIslandValid isVisible markActive markInactive matches observe onAccept onAppend onCanvasClick onCanvasDialogRemove onChangedSelectedIsland onContextMenu onDown onEnter onIslandRenamed onLeave onLeft onLoad onLoadCanvasDialog onLoadedOnIsland onMouseMove onPortsChanged onRemove1 onResize onRight onSelect onShow onSubmit onTickEndOrPostMove onUp onZoom preMoveToIsland queryX queryXAll reflow refreshTooltip regenerateBoxes registerBindHandlers registerEventBusSubscriber remove removeEventListener removeTooltip render repaint resetSizeAndPosition resetView resetViewOffset resetViewZoom rotateClockwise rotateCounterClockwise sail schedule scrollTo selectIsland setContents setContextMenu setEdgePosition setElement setHighlight setHoveringClickable setId setInitialSelection setSelectable setSizeAndPosition setStyle setTooltip setZoomLevels shouldDisplayConstructLighthousesHint shouldDisplayIsland show showPanel showSettingsPanel siblings sleep store tempHighlight toggle toggleActive updateView all append findDescendants get getSelectableLayer makeTopDialog remove

Constructors

constructor

Properties

Protected actualViewAngle

actualViewAngle: number = 0

Protected actualViewOffset

actualViewOffset: default = Vector2.ZERO

Protected Readonly actualViewScale

actualViewScale: default = Vector2.ONE

Protected actualViewZoom

actualViewZoom: number = 1

Readonly attributes

attributes: AttributeManipulator<default>

Protected Readonly body

body: default<HTMLElement>

Protected buttonSurface

buttonSurface: default<HTMLElement> = ...

Protected canZoom

canZoom: boolean = true

Protected Readonly canvas

canvas: Canvas

Readonly classes

classes: ClassManipulator<default>

closeOnTravel

closeOnTravel: boolean = true

Readonly data

data: DataManipulator<default>

Protected drawer

drawer: default<HTMLElement> = ...

edges

edges: IDialogEdges = ...

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

Protected entered

entered: boolean = false

Readonly event

event: IEventEmitter<default, ICanvasDialogEvents>

Protected Readonly header

header: Header

Readonly id

id: DialogId

Readonly info

info: default<HTMLElement> = ...

Protected Readonly internalDialog

internalDialog: default<HTMLElement>

Protected Optional lastSailAwayCheckPosition

lastSailAwayCheckPosition?: default

Protected loading

loading: boolean = true

Readonly log

log: default

Protected Readonly mainPanel

mainPanel: default<HTMLElement> = ...

Optional observing

observing?: boolean

Readonly ports

ports: IIslandsDialogPort[] = []

Readonly portsWrapper

portsWrapper: default<HTMLElement> = ...

Optional removed

removed?: string | boolean

Protected Readonly scrollableHandler

scrollableHandler: void = ...

Protected selectedIslandPosition

selectedIslandPosition: default = ...

Readonly style

style: StyleManipulator<default>

Readonly subId

subId: string = ""

Readonly title

title: default = ...

Protected uiSurface

uiSurface: default<HTMLElement> = ...

Protected viewAngle

viewAngle: number = 0

Protected viewOffset

viewOffset: default = Vector2.ZERO

Protected Readonly viewScale

viewScale: default = Vector2.ONE

Protected viewZoom

viewZoom: number = 1

Protected zoomReference

zoomReference: CanvasZoomReference = ...

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

isHovering

  • get isHovering(): boolean

  • Returns boolean

Protected island

  • get island(): undefined | default

  • Returns undefined | default

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

Methods

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

addPanel

  • Parameters

    • id: string | number

    Returns default<HTMLElement>

addScrollableWrapper

  • Parameters

    • type: "auto" | "scroll" = "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 canHideDrawer

  • 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 null | Element

contains

  • Returns whether this component contains the given element.

    Parameters

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

    Returns boolean

Protected createExecuteButton

deregisterBindHandlers

deregisterEventBusSubscriber

Protected draw

  • Returns void

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

findDescendants

  • An alias for element.querySelectorAll(selector)

    Type Parameters

    • E extends HTMLElement = HTMLElement

    Parameters

    • selector: string

    Returns NodeListOf<E>

Protected flipHorizontal

  • Returns void

Protected flipVertical

  • Returns void

focus

  • Makes this dialog the top dialog.

    Returns void

getAs

  • Type Parameters

    Parameters

    • cls: Class<C, any[]>

    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 getClosestDialog

getDialog

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

    Type Parameters

    Returns null | D

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 null | M

getMousePosition

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

getOffset

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

    Returns {
        left: number;
        top: number;
    }

    • left: number
    • top: 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

getScreen

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

    Type Parameters

    Returns null | S

getSelectionTarget

hide

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

    Returns default

Protected initializeSettingsPanel

  • Parameters

    Returns void

isActive

  • Returns boolean

isDragging

  • Returns boolean

isFocused

  • Returns boolean

isPanelVisible

  • Parameters

    • id: string | number

    Returns boolean

Protected isPlayerSwimming

  • Parameters

    Returns undefined | boolean

isSelectable

  • Returns boolean

Protected isSelectedIslandValid

  • Returns boolean

isVisible

  • Returns whether the element is visible.

    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 onAccept

  • Returns boolean

Protected onAppend

  • Event handler for when this dialog is appended

    Returns void

Protected onCanvasClick

  • Returns void

Protected onCanvasDialogRemove

  • Returns void

Protected onChangedSelectedIsland

  • Parameters

    • animate: boolean = true

    Returns void

Protected onContextMenu

Protected onDown

  • Returns boolean

Protected onEnter

  • Parameters

    • reason: "focus" | "mouse"

    Returns void

Protected onIslandRenamed

  • Parameters

    Returns void

Protected onLeave

  • Parameters

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

    Returns void

Protected onLeft

  • Returns boolean

Protected onLoad

  • Parameters

    • initial: boolean

    Returns Promise<void>

Protected onLoadCanvasDialog

  • Returns Promise<void>

Protected onLoadedOnIsland

  • Returns void

Protected onMouseMove

  • Returns void

Protected onPortsChanged

  • Parameters

    Returns void

Protected onRemove1

  • Returns void

Protected onResize

  • Returns void

Protected onRight

  • Returns boolean

Protected onSelect

  • Parameters

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

    Returns void

Protected onShow

  • Returns void

Protected onSubmit

  • Returns boolean

Protected onTickEndOrPostMove

  • Returns void

Protected onUp

  • Returns boolean

Protected onZoom

Protected preMoveToIsland

  • Returns void

queryX

  • Type Parameters

    • N extends Node = Node

    Parameters

    • selector: string

    Returns null | N

queryXAll

  • Type Parameters

    • N extends Node = Node

    Parameters

    • selector: string

    Returns N[]

reflow

  • Parameters

    • reason: string

    Returns void

refreshTooltip

  • Returns void

regenerateBoxes

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

    Parameters

    • descendants: boolean = true

    Returns void

registerBindHandlers

registerEventBusSubscriber

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

Protected render

  • Parameters

    • animationId: number = ...

    Returns void

repaint

  • Triggers a repaint on this element.

    Returns void

resetSizeAndPosition

  • Returns void

Protected resetView

  • Parameters

    • animate: boolean = true
    • resetOffset: boolean = true
    • resetZoom: boolean = true
    • resetAngle: boolean = true
    • resetScale: boolean = true

    Returns void

Protected resetViewOffset

  • Parameters

    • islandPosition: IVector2 = localIsland.position

    Returns void

Protected resetViewZoom

  • Returns void

Protected rotateClockwise

  • Returns void

Protected rotateCounterClockwise

  • Returns void

Protected sail

  • Parameters

    Returns void

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

selectIsland

  • Parameters

    • x: number
    • y: number

    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

setHoveringClickable

  • Parameters

    • hoveringClickable: boolean = true

    Returns void

setId

  • Sets the ID of this component's element.

    Parameters

    • id: string

    Returns default

setInitialSelection

  • Parameters

    • initialSelection: boolean = true

    Returns default

setSelectable

setSizeAndPosition

setStyle

  • Parameters

    • property: string
    • value: string | number

    Returns default

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

setZoomLevels

  • Parameters

    • levels: Iterable<number>

    Returns default

Protected shouldDisplayConstructLighthousesHint

Protected shouldDisplayIsland

  • Parameters

    • x: number
    • y: number
    • Optional island: default

    Returns boolean

show

  • Shows the element.

    Returns default

showPanel

  • Parameters

    • id: string | number
    • Optional disableAnimations: boolean

    Returns undefined | default<HTMLElement>

showSettingsPanel

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>

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

    • visible: boolean = ...

      The new visiblity of this element.

    Returns default

toggleActive

  • Toggle whether this dialog is "active"

    Parameters

    • reason: any
    • active: boolean

    Returns void

Protected updateView

  • Parameters

    • isDragging: boolean

    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 | ChildNode | default<HTMLElement>
    • force: boolean = false

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc