MVFv3 API Documentation
    Preparing search index...

    Type Alias FloorsSchema

    The Floors schema is a fundamental part of the MVFv3 spec. It adds a FloorCollection on the floors property (or floors.geojson in the bundle).

    A Floor is the atomic unit of the MVF. Every piece of Geometry belongs to a specific floor, and many schemas and extensions (including GeometrySchema) break their data up into a different file by FloorId.

    Floors typically represent a single level of a building, but there is also often a floor for "outside". There may be many floors in an MVF bundle, you may want to use something like the FloorStacksSchema or OutdoorsSchema to group or reason about them.

    type FloorsSchema = {
        floors: {
            features: {
                geometry:
                    | null
                    | { coordinates: [number, number][][]; type: "Polygon" }
                    | { coordinates: [number, number][][][]; type: "MultiPolygon" };
                properties: {
                    elevation: number;
                    id: `f_${string}`;
                    maxHeight?: number;
                    subtitle?: string;
                } & {
                    details?: {
                        description?: string;
                        externalId?: string;
                        icon?: string;
                        name?: string;
                        shortName?: string;
                    };
                };
                type: "Feature";
            }[];
            type: "FeatureCollection";
        };
    }
    Index

    Properties

    floors

    Properties

    floors: {
        features: {
            geometry:
                | null
                | { coordinates: [number, number][][]; type: "Polygon" }
                | { coordinates: [number, number][][][]; type: "MultiPolygon" };
            properties: {
                elevation: number;
                id: `f_${string}`;
                maxHeight?: number;
                subtitle?: string;
            } & {
                details?: {
                    description?: string;
                    externalId?: string;
                    icon?: string;
                    name?: string;
                    shortName?: string;
                };
            };
            type: "Feature";
        }[];
        type: "FeatureCollection";
    }

    Settings

    Member Visibility

    On This Page

    Properties