Engine API Reference - v2.23.0-beta.7
    Preparing search index...

    Class PropertyView

    A read-only property panel for any subject a model builder can describe: a node, a render pass, a render target. Sections and rows are keyed and reconciled in place, so refreshing at a high rate only touches the text that actually changed and never resets the scroll position or the collapsed sections.

    Index
    • Parameters

      • container: HTMLElement

        The element to render into.

      • onSelect: (target: any) => void

        The value link callback.

      Returns PropertyView

    container: HTMLElement

    The element the panel is rendered into.

    onSelect: (target: any) => void

    Called with the target of a value link when it is clicked.

    • get subject(): any

      The subject being shown.

      Returns any

    • Re-reads every shown property and updates the text that changed.

      Returns void

    • Shows a subject. The DOM is rebuilt only when the key changes, so a subject that is recreated every frame under a stable key keeps its scroll position.

      Parameters

      • subject: any

        The subject, or null to show nothing.

      • OptionalbuildModel: (subject: any) => PropertySection[]

        Turns the subject into sections.

      • Optionalkey: any = subject

        Identifies the subject across refreshes. Defaults to the subject itself.

      Returns void