Class MapVisualizer

A map-only visualizer state of chemiscope

Hierarchy

  • MapVisualizer

Properties

Methods

  • Apply the given settings to the structure panels in the visualizer

    Parameters

    Returns void

  • Add the given callback to be called whenever a setting changes. The callback will be given the path to the settings as a list of keys; and the new value of the setting.

    There is currently no way to remove a callback.

    Parameters

    • callback: ((keys: string[], value: unknown) => void)
        • (keys: string[], value: unknown): void
        • Parameters

          • keys: string[]
          • value: unknown

          Returns void

    Returns void

  • Removes all the chemiscope widgets from the DOM

    Returns void

  • Load a dataset and create a visualizer.

    This function returns a Promise<MapVisualizer> to prevent blocking the browser while everything is loading.

    Returns

    Promise that resolves to a MapVisualizer

    Parameters

    • config: MapConfig

      configuration of the visualizer

    • dataset: Dataset

      visualizer input, containing a dataset and optional visualization settings

    Returns Promise<MapVisualizer>