@magiclane/maps-sdk
    Preparing search index...

    Class GemParameter

    Hierarchy

    • GemAutoreleaseObject
      • GemParameter
    Index

    Constructors

    • Construct a parameter object.

      Parameters

      • params: { key?: string; name?: string; type?: ValueType; value?: any }

        An object containing optional properties: type, value, name, key.

      Returns GemParameter

    Properties

    key?: string
    name?: string
    type?: ValueType
    value?: any

    Methods

    • Returns the parameter as a JSON object.

      Returns Record<string, any> | null

      A JSON object containing the parameter's key, value, and name if available. Returns null if key, value, or type is null.

    • Returns number

    • Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.

      Parameters

      • pointerId: any

        The pointer ID to register

      Returns void

    • Returns { [key: string]: any }

    • Parameters

      • json: { [key: string]: any }

      Returns GemParameter

    • Creates a GemParameter with a ValueType.bool value type

      Parameters

      • __namedParameters: { key: string; name?: string; value: boolean }

      Returns GemParameter

    • Creates a GemParameter with a ValueType.int value type

      Parameters

      • __namedParameters: { key: string; name?: string; value: number }

      Returns GemParameter

    • Creates a GemParameter with a ValueType.list value type

      Parameters

      • __namedParameters: { key: string; name?: string; value: ParameterList }

      Returns GemParameter

    • Creates a GemParameter with a ValueType.real value type

      Parameters

      • __namedParameters: { key: string; name?: string; value: number }

      Returns GemParameter

    • Creates a GemParameter with a ValueType.string value type

      Parameters

      • __namedParameters: { key: string; name?: string; value: string }

      Returns GemParameter