Standard strips | NAGRAVISION Documentation Portal

Overview

A standard strip defines a rail that is single height and multi-tile. It typically represents a straightforward content strip with tiles of uniform height (width can vary if required), presented in a linear fashion.

Example configurationProperties response

For a rail that uses a standard strip blueprint (in this case, the Standard: 2:3 instance), the rail’s configurationProperties block looks like this.

JSON

...
"configurationProperties": {
  "scroll_type": "infinite_scroll",
  "client_context": [
    "uniform",
    "2x3"
  ],
  "edge_peek": true,
  "instance": "Standard: 2:3",
  "layout_style": "standard",
  "visible": true,
  "tile_style": "default",
  "type": "standard_strip",
  "max_pages": 0,
  "show_more": false,
  "tile_pattern": [
    "2x3"
  ]
},
...

Fields

The following table lists the fields that are specific to standard strip blueprints. (SeeRail reponses for a full list of rail fields.)

A custom instance of the standard strip might use any of the available values in the table.

A built-in instance will use specific values as listed in Standard strip instances, below.

Keys	Type	Values	Description
`type`	static	`standard_strip`	The `type` field defines the type of rail this blueprint describes. `standard_strip`: A `standard_strip` type defines a rail that is single height and multi-tile. It typically represents a straightforward content strip with tiles of uniform height (width can vary if required), presented in a linear fashion.
`layout_style`	static	`standard`	The `layout_style` defines how the rail should be presented to the user. It provides guidance on the display format and interaction style, helping the client to organise and showcase content effectively. `standard`: The standard layout presents tiles in a linear, continuous fashion, allowing users to scroll left or right freely without boundaries. This style is best suited for displaying a large volume of content in a seamless, uninterrupted scrolling experience. The focus is on smooth, continuous navigation through the content. Example: A long list of movies or shows that users can scroll through without limitations
`tile_pattern`	enum selector (duplicates on, re-ordering on)	`default,` `16x9,` `4x3,` `3x2,` `2x3,` `4x5,` `1x1,` `3x1,` `4x1`	The `tile_pattern` defines the layout and aspect ratio of tiles within the rail. The selected pattern, which may consist of a combination of aspect ratios, is repeated across the rail and can accommodate duplicate tiles. `default`: the tile pattern is dynamically determined by the client, meaning the client has full control over how the tiles are arranged. `16x9`, `4x3`, `2x3`, `4x5`, `1x1`, `3x1`, `4x1`: these are fixed aspect ratios for tiles. You can specify multiple ratios, and they will be repeated across the rail in the order selected. Examples: Single aspect ratio: `4x3` Result: `[4x3] [4x3] [4x3] ...` Multiple aspect ratios: `4x3, 16x9` Result: `[4x3] [16x9] [4x3] [16x9] ...` Multiple aspect ratios with duplicates: `4x3, 4x3, 16x9, 16x9` Result: `[4x3] [4x3] [16x9] [16x9] ...`
`show_more`	boolean		The `show_more` setting instructs the client whether to display a “Show More” link or button within the rail. This link allows users to navigate to a separate screen or view that is specific to the rail content, offering more detailed or expanded options. This is typically used when the content in the rail exceeds the initial set of items shown, and the user can view more items in a dedicated section. `true`: displays the “Show More” link or button, allowing the user to load additional content or navigate to a more detailed view. `false` (default): Hides the “Show More” link, limiting the user to the initially displayed content without offering the ability to view more. Notes: The actual placement, behaviour, and flow of the “Show More” functionality (e.g., the navigation to the next screen or the content load mechanism) is not defined within this blueprint and must be implemented by the client as needed. The client should ensure that the “Show More” experience is intuitive and aligns with the content layout and user interface.
`max_pages`	numeric (0 to 1000)		The `max_pages` setting defines the maximum number of pages that can be retrieved for the rail. This value allows clients to control the number of results displayed within the rail, offering more control over how much content is shown at once. 0: mo restriction on the number of pages. The client can continue retrieving pages until no more are available, allowing for an infinite or uninterrupted content stream. > 0: the client is restricted to retrieving no more than the specified number of pages. If the rail can display more content, the client must stop retrieving additional pages once the limit is reached. The `max_pages` value is an absolute maximum. However, there may not be enough content available to reach the full amount defined. In other words, if the total number of items is less than the maximum, the client will only retrieve what is available. If `max_pages` is set to a specific limit and more content exists, the `show_more`field can be used to allow the user to "break out" from the rail into a separate page where the `max_pages` limit is no longer applied. This would allow access to more content beyond the specified `max_pages` restriction. Example Usage: Unlimited pages: `max_pages: 0` This would allow the client to continue fetching additional pages as long as more content is available, without any artificial limitations. Limited pages: `max_pages: 5` This would indicate the client should be restricted to only retrieving up to five pages, even if more pages are available in the rail's content source. If fewer than five pages are available, the client will retrieve what is available.
`visible`	boolean		The `visible` setting acts as a simple flag that allows the client to show or hide a rail without removing it from the template or layout. `true` (default): the rail will be displayed to the user within the layout. `false`: the rail will be hidden from view but still remains part of the template. It can be toggled back to true later without needing to modify the layout or template structure.

Standard strip instances

Standard 2:3

Appearance	Key	Values
	`type`	`standard_strip`
	`layout_style`	`standard`
	`tile_pattern`	`["2x3"]`
	`show_more`	`false`
	`max_pages`	`0`
	`visible`	`true`

Standard 2:3 & 4:3

Appearance	Key	Values
	`type`	`standard_strip`
	`layout_style`	`standard`
	`tile_pattern`	`["2x3","4x3"]`
	`show_more`	`false`
	`max_pages`	`0`
	`visible`	`true`

Standard 16:9

Appearance	Key	Values
	`type`	`standard_strip`
	`layout_style`	`standard`
	`tile_pattern`	`["16x9"]`
	`show_more`	`false`
	`max_pages`	`0`
	`visible`	`true`

Standard 4:3

Appearance	Key	Values
	`type`	`standard_strip`
	`layout_style`	`standard`
	`tile_pattern`	`["4x3"]`
	`show_more`	`false`
	`max_pages`	`0`
	`visible`	`true`