Function populateFloorAreas

  • populateFloorAreas(
        seed: SeedV16 | Seed,
        floorAreasM2: number[],
        options?: {
            basementAreaM2?: number;
            basementDepthRatio: number;
            basementPerimeter?: number;
            foundationType: "crawlSpace" | "SOG";
            perimeterMeters?: number | number[];
        },
    ): SeedV16
    | Seed

    Populates seed with new Seed Objects using specified dimensions. This WILL overwrite existing dimensions.

    Parameters

    • seed: SeedV16 | Seed

      The seed object to populate

    • floorAreasM2: number[]

      Floor area for each storey up to a maximum of 3 storeys, excluding basement. If a basement is fully above grade, it gets added as the first element of this array instead of using the basementAreaM2 option.

    • options: {
          basementAreaM2?: number;
          basementDepthRatio: number;
          basementPerimeter?: number;
          foundationType: "crawlSpace" | "SOG";
          perimeterMeters?: number | number[];
      } = ...

      Additional options for populating the seed (optional)

      • OptionalbasementAreaM2?: number

        Optional area of basement

      • basementDepthRatio: number

        Ratio of basement depth to basement height

      • OptionalbasementPerimeter?: number

        Perimeter of the basement

      • foundationType: "crawlSpace" | "SOG"

        Type of foundation to use with no basement ('crawlspace' or 'SOG')

      • OptionalperimeterMeters?: number | number[]

        Perimeter that is either a single number to share between all floors, or an array containing a perimeter for each floor. Value is assumed if not specified.

    Returns SeedV16 | Seed

    • The populated seed object

Settings

Member Visibility