This is archived CyberStore v2024.1 documentation. For current guidance, see the latest documentation.

CatalogCategoryDiagramListing

CatalogCategoryDiagramListing displays Hot Spot diagrams for catalog items that have them enabled. It was introduced in v2.5.

CatalogCategoryDiagramListing Hot Spot diagrams

Configurable properties

Property	Default	Valid values or format	Effect
`HotSpotDiagramEmptyDisplay` Boolean	`false`	`true`, `false`	Controls whether the diagram listing is displayed when no data is available.
`HotSpotDiagramFolderLocation` String	`"~/CatalogHotSpot.aspx"`		Sets the Hot Spot diagram folder location.
`HotSpotDiagramGridAlwaysDisplayPager` Boolean	`false`	`true`, `false`	Controls whether the grid pager is displayed when there are fewer than two pages.
`HotSpotDiagramGridDisplay` Boolean	`true`	`true`, `false`	Selects whether the listing uses the grid or data-list display.
`HotSpotDiagramGridDisplayDescriptionColumn` Boolean	`true`	`true`, `false`	Controls the grid description column.
`HotSpotDiagramGridDisplayDescriptionHeader` String	`"Description"`		Sets the grid description-column header.
`HotSpotDiagramGridDisplayDiagramColumn` Boolean	`true`	`true`, `false`	Controls the grid diagram-image column.
`HotSpotDiagramGridDisplayDiagramHeader` String	`"Diagram"`		Sets the grid diagram-image header.
`HotSpotDiagramGridDisplayHeaders` Boolean	`true`	`true`, `false`	Controls grid header display.
`HotSpotDiagramGridDisplayHeadlineColumn` Boolean	`true`	`true`, `false`	Controls the grid headline column.
`HotSpotDiagramGridDisplayHeadlineHeader` String	`"Head Line"`		Sets the grid headline-column header.
`HotSpotDiagramGridDisplayNameColumn` Boolean	`true`	`true`, `false`	Controls the grid diagram-name column.
`HotSpotDiagramGridDisplayNameHeader` String	`"Name"`		Sets the grid diagram-name header.
`HotSpotDiagramGridPageSize` Integer	`ITM_CatalogListingPageSize` or `10`		Sets the Hot Spot diagram grid page size.
`HotSpotDiagramListColumns` Integer	`2`		Sets the number of columns in the data-list layout.
`HotSpotDiagramListGridLines` String	`"None"`		Sets grid lines for the data-list layout.
`HotSpotDiagramListRepeatDirection` String	`"Horizontal"`		Sets the data-list repeat direction.
`HotSpotDiagramListRepeatLayout` String	Not specified		Sets the data-list layout type.
`HotSpotDiagramNoDataMessage` String	`"Sorry, there are no Diagrams associated with this Item."`		Sets the message shown when no diagram data is available.
`HotSpotDiagramPhotoWidth` Integer	`100`		Sets the diagram photo width.
`HotSpotDiagramURL` String	`"~/CatalogHotSpot.aspx"`		Sets the link URL for a Catalog Hot Spot.

SitePages.config example

The following example loads CatalogCategoryDiagramListing.ascx and applies the documented literal defaults. The following properties are omitted because they do not have documented literal defaults: HotSpotDiagramListRepeatLayout.

<Control src="CatalogCategoryDiagramListing.ascx"
         HotSpotDiagramEmptyDisplay="false"
         HotSpotDiagramFolderLocation="~/CatalogHotSpot.aspx"
         HotSpotDiagramGridAlwaysDisplayPager="false"
         HotSpotDiagramGridDisplay="true"
         HotSpotDiagramGridDisplayDescriptionColumn="true"
         HotSpotDiagramGridDisplayDescriptionHeader="Description"
         HotSpotDiagramGridDisplayDiagramColumn="true"
         HotSpotDiagramGridDisplayDiagramHeader="Diagram"
         HotSpotDiagramGridDisplayHeaders="true"
         HotSpotDiagramGridDisplayHeadlineColumn="true"
         HotSpotDiagramGridDisplayHeadlineHeader="Head Line"
         HotSpotDiagramGridDisplayNameColumn="true"
         HotSpotDiagramGridDisplayNameHeader="Name"
         HotSpotDiagramGridPageSize="ITM_CatalogListingPageSize` or `10"
         HotSpotDiagramListColumns="2"
         HotSpotDiagramListGridLines="None"
         HotSpotDiagramListRepeatDirection="Horizontal"
         HotSpotDiagramNoDataMessage="Sorry, there are no Diagrams associated with this Item."
         HotSpotDiagramPhotoWidth="100"
         HotSpotDiagramURL="~/CatalogHotSpot.aspx" />

Add this <Control> element to the appropriate page placeholder as described in The SitePages.config File.

Inherited properties

CatalogCategoryDiagramListing inherits listing behavior from ListingControl and shared conditions from CyberStoreBaseControl.