Type Alias TFloorUpdateState

TFloorUpdateState: {
    altitude?: number;
    areas?: { type?: "floor.areas"; visible?: boolean };
    footprint?: {
        altitude?: number;
        color?: string;
        height?: number;
        opacity?: number;
        type?: "floor.footprint";
        visible?: boolean;
    };
    geometry?: { opacity?: number; type?: "floor.geometry"; visible?: boolean };
    images?: { type?: "floor.images"; visible?: boolean };
    labels?: { enabled?: boolean; type?: "floor.labels" };
    markers?: { enabled?: boolean; type?: "floor.markers" };
    occlusion?: { type?: "floor.occlusion" };
    paths?: { type?: "floor.paths"; visible?: boolean };
    type?: "floor";
    visible?: boolean;
}

Type declaration

  • Optionalaltitude?: number

    The altitude of the floor.

    Default

    0
  • Optionalareas?: { type?: "floor.areas"; visible?: boolean }
    • Optionaltype?: "floor.areas"
    • Optionalvisible?: boolean

      Visibility of the areas on the floor.

      Default

      true
  • Optionalfootprint?: {
        altitude?: number;
        color?: string;
        height?: number;
        opacity?: number;
        type?: "floor.footprint";
        visible?: boolean;
    }
    • Optionalaltitude?: number

      Altitude of the footprint relative to the floor.

      Default

      0
    • Optionalcolor?: string

      Color of the footprint.

      Default

      #ffffff
    • Optionalheight?: number

      Height of the footprint relative to altitude.

      Default

      0
    • Optionalopacity?: number

      Opacity of the footprint.

      Default

      1
    • Optionaltype?: "floor.footprint"
    • Optionalvisible?: boolean

      Whether the footprint is visible.

      Default

      false
  • Optionalgeometry?: { opacity?: number; type?: "floor.geometry"; visible?: boolean }

    State of the geometry on the floor.

    • Optionalopacity?: number

      Opacity of the floor geometry.

      Default

      1
    • Optionaltype?: "floor.geometry"
    • Optionalvisible?: boolean

      Visibility of floor geometry.

      Default

      true
  • Optionalimages?: { type?: "floor.images"; visible?: boolean }
    • Optionaltype?: "floor.images"
    • Optionalvisible?: boolean

      Visibility of the images on the floor.

      Default

      true
  • Optionallabels?: { enabled?: boolean; type?: "floor.labels" }
    • Optionalenabled?: boolean

      Whether the labels are enabled to be shown when the floor is visible.

      Default

      true
    • Optionaltype?: "floor.labels"
  • Optionalmarkers?: { enabled?: boolean; type?: "floor.markers" }
    • Optionalenabled?: boolean

      Whether the markers are enabled to be shown when the floor is visible.

      Default

      true
    • Optionaltype?: "floor.markers"
  • Optionalocclusion?: { type?: "floor.occlusion" }
  • Optionalpaths?: { type?: "floor.paths"; visible?: boolean }
    • Optionaltype?: "floor.paths"
    • Optionalvisible?: boolean

      Visibility of the paths on the floor.

      Default

      true
  • Optionaltype?: "floor"
  • Optionalvisible?: boolean

    The visibility of the floor, including the geometry, labels, and markers.

    Default

    false

Settings

Member Visibility