DataPA Enterprise Dashboard Controls API Reference

The GaugeData type exposes the following members.

Constructors

  Name Description
Public method GaugeData
Initializes a new instance of the GaugeData class

Methods

  Name Description
Public method BuildSummaryDataTable
Builds the summary data table for this object
Public method GetObjectData
Public method RebuildDataProvider
Forces the data provider to recalculate
Public method ResetDataProvider
Forces the data provider to recalculate next time the object is rendered
Public method ResetSummaryDatatable
Resets the data tables to nothing.
Public method SetObjectData

Fields

  Name Description
Public field Static member ClassId
Public field Static member EventsId
Public field Static member InterfaceId

Properties

  Name Description
Public property Clone
Gets cloned copy of this object.
Public property Colour
Gets and sets the colour for this gauge object
Public property DataModified
Gets and sets a value that indicates if the summary data definition has changed since the last call to BuildSummaryDataTable.
Public property DataTag
Gets and sets a unique string that identifies the source data set from the query, resultset collection.
Public property EndLabel
Gets and sets the End label to display instead of a value at the end of the scale
Public property Filter
Gets and sets a DashboardFilter object used to filter the dataset for this object.
Public property Guid
Gets ans sets the Guid for this object
Public property HasData
Gets a property that indicates if this object has data
Public property ID
Gets the unique ID of this object
Public property IterationType
Gets and sets a value that indicates the iteration type for this Gauge data.
Public property LabelPosition
Gets and sets a value that indicates the positioning of labels within this gauge
Public property LabelStep
Gets and sets a value that indicates that a label will be shown every n-th tick mark.
Public property NumMajorTickMarks
Gets and sets the number of Major Tick Marks shown on this gauge.
Public property NumMinorTickMarks
Gets and sets the number of Minor Tick Marks shown on this gauge.
Public property Parent
Gets and sets the parent DashboardObject for this GaugeData object.
Public property PercentageValue
Gets the current value for this object as a percentage of the range
Public property RangeCollection
Gets and sets the range collection for the Gauge object
Public property RequiresSummaryProviderRebuild
Gets a value that indicates if the summary data provider needs rebuilt for this object
Public property ShowAsPercentage
Gets and sets a value that indicates if the values on the Gauge should be shown as a percentage
Public property ShowLabels
Gets and sets a value that indicates if labels with be shown on this Gauge object
Public property ShowTickMarks
Gets and sets a value that indicates if tickmarks will be shown on this Gauge
Public property ShowValue
Gets and sets a value that indicates if the value will be displayed on the gauge
Public property SourceDataTable
Gets the source data table that will be used to calculate the Gauge ranges and value.
Public property StartLabel
Gets and sets the start label to display instead of a value at the beginning of the scale
Public property SummaryColumn
Gets and sets a SummaryColumn object that will be used to calculate the value represented by this gauge.
Public property SummaryColumns
Gets a SummaryColumns collection specifying the summary columns required for this Gauge data.
Public property SummaryDataProvider
Gets the summary data provider object for this GaugeData object
Public property TickMarkPosition
Gets and sets a value that indicates the positioning of Tick Marks within this gauge
Public property UseLabelAsValue
Gets and sets a value that indicates if values should be expressed using the range label rather than the value
Public property Value
Gets the value this Gauge object should display

See Also