UI.ConfigVisualizer

Class used to visualize configuration file contents in a simple way.

Index

Constructors

• constructor

Methods

• clearVisualContent
• createVisualContent

Constructors

constructor

• new ConfigVisualizer(config: Config, prefix: string): ConfigVisualizer
• new ConfigVisualizer(config: Config): ConfigVisualizer

• Constructs new UI.ConfigVisualizer instance with specified elements names prefix.

  ---

  Parameters

  • config: Config

    configuration file to be loaded

  • prefix: string

    elements names prefix used for this visualizer

  Returns ConfigVisualizer

Methods

clearVisualContent

• clearVisualContent(elements: ElementSet): void

• Removes all elements with current element name prefix. In other words, removes all elements that were created by this. UI.ConfigVisualizer instance

  ---

  Parameters

  • elements: ElementSet

    target UI.WindowContent.elements section

  Returns void

createVisualContent

• createVisualContent(elements: ElementSet, prefs?: Partial<Vector>): void

• Creates elements in the window to visualize configuration file.

  ---

  Parameters

  • elements: ElementSet

    target UI.WindowContent.elements section

  • optionalprefs: Partial<Vector>

    top left position of the first element. Default position is (0, 0, 0)

  Returns void