DisplayMetadata

 public interface DisplayMetadata {
  name?: string;
  color?: string;
  glyph?: string;
}

A desktop agent (typically for system channels) may want to provide additional information about how a channel can be represented in a UI. A common use case is for color linking.

See also

• Channel
• DesktopAgent.getSystemChannels

Properties

name

name?: string;

The display name for the channel.

color

color?: string;

A name, hex, rgba, etc. that should be associated within the channel when displaying it in a UI.

glyph

glyph: string;

A URL of an image that can be used to display this channel.