Banner Support
Display banners, marquee text, and image carousels in HMI pages.
Draft
This documentation is a draft and will be updated after testing.
Overview
TOR Reference: 3.1.1.5
Banner support enables displaying dynamic content in HMI pages including scrolling text, static images, and image carousels.
Banner Types
| Type | Description |
|---|---|
| Text Marquee | Scrolling text ticker |
| Static Image | Single image display |
| Carousel | Rotating image slideshow |
Configuration
Banners are configured in Settings > Banner Settings.
Banner Properties
| Property | Description |
|---|---|
| Name | Display name for the banner |
| Type | Marquee, Static, or Carousel |
| Items | List of content items |
Banner Item Properties
| Property | Description |
|---|---|
| Content | Text or image URL |
| Duration | Display duration (for carousel) |
| Order | Display order |
Marquee Options
| Option | Description |
|---|---|
| Scroll Direction | Left, Right, Up, Down |
| Scroll Speed | Pixels per second |
| Background Color | Background color |
| Text Color | Text color |
Transition Effects
For carousel banners:
| Effect | Description |
|---|---|
| Fade | Crossfade between images |
| Slide | Slide animation |
| None | Instant switch |
Technical Implementation
Entity Structure
public class BannerContent : BaseMasterEntity
{
public string Name { get; set; }
public int BannerType { get; set; }
public IList<BannerItem> Items { get; set; }
}
public class BannerItem : BaseEntity
{
public string Content { get; set; }
public int Duration { get; set; }
public int DisplayOrder { get; set; }
}
API Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/bannersettings | List all banners |
| GET | /api/bannersettings/{id} | Get banner by ID |
| POST | /api/bannersettings | Create banner |
| PUT | /api/bannersettings/{id} | Update banner |
| DELETE | /api/bannersettings/{id} | Delete banner |