Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    A custom HTMLElement used to render a tagged set of 2D grid offsets.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _value: Set<any>
    _internals: ElementInternals

    Attached ElementInternals which provides form handling functionality.

    _primaryInput: HTMLElement

    The primary input (if any). Used to determine what element should receive focus when an associated label is clicked on.

    formAssociated: boolean = true

    Declare that this custom element provides form element functionality.

    icons: { add: string; remove: string } = ...
    labels: { add: string; placeholder: string; remove: string } = ...
    observedAttributes: string[] = ...

    Attributes requiring change notifications

    tagName: string = "grid-offset-2d-tags"

    Accessors

    • get abortSignal(): AbortSignal

      An AbortSignal that can be passed to event listeners registered in subclasses. The signal will ensure that the listener is removed when the element is disconnected from the DOM. Not available in the constructor.

      Returns AbortSignal

    • get disabled(): boolean

      Is this element disabled?

      Returns boolean

    • get editable(): boolean

      Is this field editable? The field can be neither disabled nor readonly.

      Returns boolean

    • get form(): HTMLFormElement

      The form this element belongs to.

      Returns HTMLFormElement

    • get name(): string

      The input element name.

      Returns string

    Methods

    • Internal

      Apply key attributes on the containing custom HTML element to input elements contained within it.

      Parameters

      • input: HTMLElement

      Returns void

    • Protected

      A method provided for subclasses to perform tear-down workflows as an alternative to overriding disconnectedCallback.

      Returns void

    • Protected

      Initialize innerText or an initial value attribute of the element as a comma-separated list of currently assigned string tags.

      Parameters

      • Optionalvalues: string[]

        An array of initial values.

      Returns void

    • Protected

      Special handling when the custom element is clicked. This should be implemented to transfer focus to an appropriate internal element.

      Parameters

      • event: PointerEvent

      Returns void

    • Render the tagged string as an HTML element.

      Parameters

      • tag: string

        The raw tag value

      • Optionallabel: string

        An optional tag label

      • Optionaleditable: boolean = true

        Is the tag editable?

      Returns HTMLDivElement

      A rendered HTML element for the tag