Back to API Home

The Viewer type exposes the following members.

Properties

  NameDescription
Public propertyDashboard
Gets or sets the dashboard that the viewer will display. This property should be set to nullNothingnullptra null reference (Nothing in Visual Basic) when the dashboard no longer wishes to be displayed so that the viewer can properly de-subscribe to its events.
Public propertyHasAllExternalDataControlsFinished
Gets or sets a value indicating whether this instance has all external data controls finished.
Public propertyInstanceId
Gets the instance id that identifies the unique id of this instance of the viewer.
Public propertyIsAnnotateMode
Gets a value indicating whether this instance is in annotate mode.
Public propertyIsAnnotateModeSupported
Gets a value indicating whether this instance supports annotate mode. This is determined by if any controls within the dashboard support annotate mode and at least one is enabled.
Public propertyIsPreview
Gets or sets a value indicating whether the viewer is in preview mode. In preview mode, KPIs that are not checked-in, only saved, will be retrieved. This value must be set before the OnApplyTemplate phase as after that point changing it will have no affect.
Public propertyIsSimpleDisplayModeEnabled
Gets or sets a value indicating whether this instance is in a "simple" display mode. This is used for image creation. If so, annotations, real-time updates and animations are disabled for this viewer. This must be set before the Dashboard is loaded to have any effect.
Public propertyIsSimulatedDataEnabled
Gets or sets a value indicating whether the viewer should use simulated data. In this mode, the wrappers will be called as if the designer is showing them. This has the benefit that no actual data-retrieval will be done, providing a good mode for a preview of just the layout without any data.
Public propertyTrackingId
Unique GUID meant to identify a particular dashboard being viewed.

See Also