Type Alias TMultiFloorViewOptions

TMultiFloorViewOptions: {
    __EXPERIMENTAL_darkenSpacesExposedToAbove?: boolean;
    enabled?: boolean;
    floorGap?: number | "auto";
    footprintColor?: string | Partial<Record<Floor["id"], string>>;
    footprintOpacity?: number;
    footprintOutline?: boolean;
    spacesOpenToBelowEnabled?: boolean;
    updateCameraElevationOnFloorChange?: boolean;
}

Options for controlling multi-floor view. When enabled, displays all floors in a building stacked vertically below the active floor, allowing users to see the building's vertical structure and navigate between floors. The active floor is fully rendered while lower floors appear as semi-transparent footprints.

Type declaration

  • Optional Experimental__EXPERIMENTAL_darkenSpacesExposedToAbove?: boolean

    Whether to darken spaces that are exposed to the floor above. Only applies when spacesOpenToBelowEnabled is true.

    Default

    true
    @experimental
  • Optionalenabled?: boolean

    Enable multi-floor view to show floors stacked vertically below the active floor.

    Default

    true
  • OptionalfloorGap?: number | "auto"

    The vertical spacing between floors, measured in meters. This controls how far apart the floors appear when stacked. If a number is provided, this value will be used for all floors. If 'auto' is provided, then the gap will be calculated based on the sum of all previous floors' max height or the default gap of 10 meters if no max height is present for any of the provided floors.

    Default

    'auto'
  • OptionalfootprintColor?: string | Partial<Record<Floor["id"], string>>

    The color of the floor footprints when in multi-floor view. Accepts either:

    • A CSS color string (hex, rgb, rgba, named colors) applied to all floors
    • An object mapping floor IDs to color strings for per-floor coloring

    When using an object, floors without a specified color will use the internal default ('#ffffff').

    Example

    // Single color for all floors
    footprintColor: '#ff0000'

    Example

    // Per-floor colors
    footprintColor: {
      'floor-1': '#ff0000',
      'floor-2': '#00ff00',
      'floor-3': '#0000ff'
    }

    Default

    '#ffffff'
  • OptionalfootprintOpacity?: number

    The opacity of the floor footprints when in multi-floor view.

    Default

    1
  • OptionalfootprintOutline?: boolean

    The outline of the floor footprints when in multi-floor view.

    Default

    true
  • Optional ExperimentalspacesOpenToBelowEnabled?: boolean

    Whether to enable spaces open to below (ceiling cutouts that expose lower floors).

    When this is enabled, and spaces that have kind "void" or "otb" will be cut out of the ceiling exposing the floor below. Any holes in the footprint will also be cut out but will have walls built around them.

    Default

    false
    @experimental
  • OptionalupdateCameraElevationOnFloorChange?: boolean

    Automatically adjust the camera elevation when switching floors to match the floor's altitude.

    Default

    true

Settings

Member Visibility