Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfoPanelContentViewOptions

A data type that represents the configuration options for an info panel content view.

Hierarchy

Index

Properties

Optional className

className: string

CSS class name to add to the view's element.

Optional data

data: any

Optional id

id: string

Unique identifier.

Optional renderer

renderer: Function | string

Renderer for the view, which can either be an HTML string or a function that receives the view's data, if any, and returns the final HTML string to render as the view's content.

Optional request

request: ApiRequest | (() => ApiRequest)

Request to use when loading data for the content view. This request should load all data that is required by each section view. For API requests, this will often be a batch request.

This value can either be a request instance or a function that returns a request instance.

Optional requiresData

requiresData: boolean

A Boolean value that indicates whether the view requires valid data to be provided in order for it to be rendered. When this value is true and there is no data provided, then the view will be rendered as empty.

Default value is false.

Optional ui

ui: {}

An object that defines the CSS selectors for various UI elements in the view and their reference keys. When a view has been rendered and added to the DOM, you can reference and access these UI targets using this.ui.#key#, where #key# is the key used with this object.

Type declaration

  • [key: string]: string

Optional units

units: Units

views

An array of view configurations or section view keys to render as part of this content view. The order in which they appear in the array is the order in which they will be rendered in the info panel.

Generated using TypeDoc