Type alias TGetVenueOptions

TGetVenueOptions: {
    accessToken?: string;
    baseUri?: string;
    baseUrl?: string;
    clientId?: string;
    clientSecret?: string;
    emitAnalyticsEvents?: boolean;
    fallbackToNavigatorLanguages?: boolean;
    headers?: {
        [key in string]: string
    };
    includeHidden?: boolean;
    language?: string;
    noAuth?: boolean;
    perspective?: string;
    platformString?: string;
    preloadMapGeometry?: boolean;
    secure?: boolean;
    things?: ThingsOption;
    useDraftData?: boolean;
    venue: string;
}

Type declaration

  • Optional accessToken?: string
  • Optional baseUri?: string
  • Optional baseUrl?: string
  • Optional clientId?: string
  • Optional clientSecret?: string
  • Optional emitAnalyticsEvents?: boolean
  • Optional fallbackToNavigatorLanguages?: boolean

    Fallback to navigator language if the language is not available

    Default

    true
  • Optional headers?: {
        [key in string]: string
    }
  • Optional includeHidden?: boolean
  • Optional language?: string
  • Optional noAuth?: boolean
  • Optional perspective?: string
  • Optional platformString?: string
  • Optional preloadMapGeometry?: boolean
  • Optional secure?: boolean
  • Optional things?: ThingsOption

    An object specifying additional properties to fetch for each data item. Each key represents a data item (e.g., 'locations', 'nodes'), and the value is an array of strings indicating extra properties to be included.

    Example

    For example:

    getVenue({
      venue: 'some-venue',
      things: { vortexes: [ 'material' ]
    }})
  • Optional useDraftData?: boolean
  • venue: string

Settings

Member Visibility

Theme