MVFv3 API Documentation
    Preparing search index...

    Type Alias NavigationFlagDeclarations

    NavigationFlagDeclarations: {
        [key: string]: { bit: number; index: number } & {
            details?: {
                description?: string;
                externalId?: string;
                icon?: string;
                name?: string;
                shortName?: string;
            };
        };
    }

    A map of all NavigationFlagDeclarations present in the MVF. The key is the durable value a developer should use to interact with the flag when wayfinding, and the value is the definition of the flag that describes how to determine whether it's set in an object's flags array.

    Type declaration

    • [key: string]: { bit: number; index: number } & {
          details?: {
              description?: string;
              externalId?: string;
              icon?: string;
              name?: string;
              shortName?: string;
          };
      }

      Type declaration

      • bit: number

        The bit position of the flag in a flag's bitfield. ie, 0 means the first bit, 1 means the second bit, etc. A flag bitfield with that bit set to 1 means the flag is present. Other than for Well Known Flags, this is not expected to be durable across different versions of the same MVF.

      • index: number

        The index of the flag in a flags array. ie, 0 means the first bitfield, 1 means the second bitfield, etc.

      • Optionaldetails?: {
            description?: string;
            externalId?: string;
            icon?: string;
            name?: string;
            shortName?: string;
        }

        {@inheritDoc utility-types/details!Details}

        Details

    Settings

    Member Visibility