Type Alias FootprintConfig

FootprintConfig: {
    color: string | Partial<Record<Floor["id"], string>>;
    opacity?: number;
    outline: boolean;
    spacesOpenToBelowEnabled: boolean;
    spacesOpenToBelowVisualEffectDarkenAmount?: number;
    spacesOpenToBelowVisualEffectDarkenUseDepth?: boolean;
    spacesOpenToBelowVisualEffectDesaturateAmount?: number;
    spacesOpenToBelowVisualEffectDesaturateUseDepth?: boolean;
    spacesOpenToBelowVisualEffectEnabled?: boolean;
    spacesOpenToBelowVisualEffectWashOutAmount?: number;
    spacesOpenToBelowVisualEffectWashOutUseDepth?: boolean;
}

Configuration for the footprint rendered beneath stacked floors in multi-floor view, controlling its color, opacity, outlines, and the visual treatment of spaces open to the floor below.

Type declaration

  • color: string | Partial<Record<Floor["id"], string>>

    The color of the footprint. Can be a single color string applied to all floors, or an object mapping floor IDs to colors. Floors without a specified color will use the default ('#ffffff').

  • Optionalopacity?: number

    Optional opacity override. If provided, overrides internal elevation-based opacity calculation.

  • outline: boolean

    Whether to show outlines on footprint walls and ceilings.

  • spacesOpenToBelowEnabled: boolean

    Whether spaces open to below (ceiling cutouts) are enabled.

  • OptionalspacesOpenToBelowVisualEffectDarkenAmount?: number
  • OptionalspacesOpenToBelowVisualEffectDarkenUseDepth?: boolean
  • OptionalspacesOpenToBelowVisualEffectDesaturateAmount?: number
  • OptionalspacesOpenToBelowVisualEffectDesaturateUseDepth?: boolean
  • OptionalspacesOpenToBelowVisualEffectEnabled?: boolean
  • OptionalspacesOpenToBelowVisualEffectWashOutAmount?: number
  • OptionalspacesOpenToBelowVisualEffectWashOutUseDepth?: boolean

Settings

Member Visibility