MVFv3 API Documentation
    Preparing search index...

    Type Alias AnnotationsSchema

    The Annotations extension add a per floor array of AnnotationProperties as 'annotations' and a single object of AnnotationSymbol keyed by string as 'annotationSymbols'.

    The symbolKey property of the AnnotationProperties must be a key in the annotationSymbols object, and will contain the icon URL and user facing name of the symbol.

    type AnnotationsSchema = {
        annotations: Partial<
            {
                [key: `f_${string}`]: (
                    { geometryId: `g_${string}` } & {
                        id: `a_${string}`;
                        symbolKey: string;
                        externalId?: string;
                    }
                )[];
            },
        >;
        annotationSymbols: Partial<
            { [key: string]: { name: string; url: string } },
        >;
    }
    Index

    Properties

    annotations annotationSymbols

    Properties

    annotations: Partial<
        {
            [key: `f_${string}`]: (
                { geometryId: `g_${string}` } & {
                    id: `a_${string}`;
                    symbolKey: string;
                    externalId?: string;
                }
            )[];
        },
    >
    annotationSymbols: Partial<{ [key: string]: { name: string; url: string } }>

    Settings

    Member Visibility

    On This Page

    Properties