Type alias ShareChartOptions

ShareChartOptions: {
    chartImage: Blob;
    context: any;
    showMessage?: boolean;
    target: string[] | TeamChannelTarget;
    timestamp?: number;
}

Options provided to the share function to share a chart to a Teams chat.

Type declaration

  • chartImage: Blob

    Image data for the chart to be shared. Supported image types: gif, jpg, png.

  • context: any

    Instrument context data to share in the form of an FDC3 instrument context which must include the id.ticker value at a minimum and ideally name also (if required, you may also include additional properties and metadata to support your workflows).

  • Optional showMessage?: boolean

    Determines whether the Teams app will open and focus on the message that was posted (defaults to true).

  • target: string[] | TeamChannelTarget

    Provide a list of user email addresses to share to a group chat of those users, otherwise provide team/channel IDs to share to a channel chat.

  • Optional timestamp?: number

    Timestamp of the date to display along with the chart. If not provided, no date will be displayed.

Settings

Member Visibility

Theme

Generated using TypeDoc