Type Alias GlobalState

GlobalState: {
    backgroundAlpha: number;
    backgroundColor: string;
    environment: EnvMapOptions;
    geometry: { hoverColor: string };
    multiFloorView: MultiFloorViewEffectState;
    text3d: { hoverColor: string };
}

Map-wide state applied to all elements, such as the background color, hover highlight color, and shared visibility flags. Returned by MapView.getState and consumed by extensions that need a snapshot of the global render state.

Type declaration

  • backgroundAlpha: number

    The alpha value of the background, between 0 and 1.

    Default

    1
  • backgroundColor: string

    The color of the background, in hex format(#000000).

  • environment: EnvMapOptions

    environment map for reflections.

    Default

    'basic'
  • geometry: { hoverColor: string }
    • hoverColor: string

      hover color of the geometries

  • multiFloorView: MultiFloorViewEffectState

    Visual effect settings for floors visible through open-to-below spaces below the current floor.

  • text3d: { hoverColor: string }
    • hoverColor: string

      hover color of the text3d

Settings

Member Visibility