MVFv3 API Documentation
    Preparing search index...

    Type Alias AnnotationProperties

    Annotations define an instance of a particular symbol, like smoke alarm or parking, on a floor. They MUST only be linked to geometry that is a Point. Their symbolKey will be the key in the annotationSymbols object that defines the icon and name of the symbol.

    Annotations are useful to place as markers on the map. More complex objects with more properties and more differences between instances are better modeled with something like Locations

    type AnnotationProperties = {
        geometryId: `g_${string}`;
        externalId?: string;
        id: `a_${string}`;
        symbolKey: string;
    }
    Index

    Properties

    geometryId externalId? id symbolKey

    Properties

    geometryId: `g_${string}`
    externalId?: string

    The external identifier for the annotation. Optional.

    id: `a_${string}`

    The unique identifier for the annotation.

    symbolKey: string

    The symbol identifier for the annotation. This must be a key in the annotation symbols record, any other value is considered invalid.

    Settings

    Member Visibility

    On This Page

    Properties