Class StoryElement

Constructor for interactive story elements.

Example

     const element = StoryElement
         .at({ x: 0, y: 0, width: 10, height: 10 })
         .reaction('👍', { dark: true })

Methods

location reaction url venue venueFromInline at

Methods

location

  • location(params: { latitude: number; longitude: number }): RawMediaAreaGeoPoint

  • Parameters

    • params: { latitude: number; longitude: number }
      • latitude: number

        Latitude of the geolocation

      • longitude: number

        Longitude of the geolocation

    Returns RawMediaAreaGeoPoint

reaction

  • reaction(
        reaction: InputReaction,
        params?: { dark?: boolean; flipped?: boolean },
    ): RawMediaAreaSuggestedReaction

  • Parameters

    • reaction: InputReaction
    • params: { dark?: boolean; flipped?: boolean } = {}
      • Optionaldark?: boolean

        Whether this reaction is on a dark background

      • Optionalflipped?: boolean

        Whether this reaction is flipped (i.e. has tail on the left)

    Returns RawMediaAreaSuggestedReaction

url

  • url(url: string): RawMediaAreaUrl

  • Parameters

    • url: string

    Returns RawMediaAreaUrl

venue

  • venue(
        params: {
            address: string;
            latitude: number;
            longitude: number;
            source: VenueSource;
            title: string;
        },
    ): RawMediaAreaVenue

  • Parameters

    • params: {
          address: string;
          latitude: number;
          longitude: number;
          source: VenueSource;
          title: string;
      }
      • address: string

        Venue address

      • latitude: number

        Latitude of the geolocation

      • longitude: number

        Longitude of the geolocation

      • source: VenueSource

        Source where this venue was acquired

      • title: string

        Venue name

    Returns RawMediaAreaVenue

venueFromInline

Staticat

  • at(
        params: {
            height: number;
            rotation?: number;
            width: number;
            x: number;
            y: number;
        },
    ): StoryElement

  • Parameters

    • params: { height: number; rotation?: number; width: number; x: number; y: number }

    Returns StoryElement

Settings

Member Visibility

On This Page

Methods