dundas.controls.DataLabel Class

 

Inheritance Hierarchy

 
Class
   dundas.controls.DataControl
      dundas.controls.DataLabel
 

Properties

 
  Name Description
annotationStyle Gets or sets the annotation style.
background Gets or sets the brush used to fill the background of the control. Inherited from dundas.controls.DataControl.
borderBrush Gets or sets the brush used to fill the border around the control. Inherited from dundas.controls.DataControl.
borderRadius Gets or sets the radius in pixels for rounding the corners of the border. Inherited from dundas.controls.DataControl.
borderStyle Gets or sets the style of the border around the control. Inherited from dundas.controls.DataControl.
borderWidth Gets or sets the width of the border around the control. Inherited from dundas.controls.DataControl.
canvasService Gets the canvas service associated with this control. Inherited from dundas.controls.DataControl.
colorRules Gets an array of rules determining the data label background color based on a data value.
container Gets the DOM element this control will render to. Inherited from dundas.controls.DataControl.
currentStyleId Gets or sets the current style ID.
darkFontColor Gets or sets the font color used to contrast against light colors from color rules.
desiredHeight Gets the desired height of this control.
height Gets the current rendered height of the control. Inherited from dundas.controls.DataControl.
horizontalTextAlignment Gets or sets the horizontal alignment of text.
hoverBackground Gets or sets the background of the data label when the mouse hovers over the control.
hoverFontColor Gets or sets the font color of the data label when the mouse hovers over the control.
id Gets a unique value identifying this instance. Inherited from dundas.controls.DataControl.
innerPadding Gets the total padding reserved between the boundaries of the control and its content. Inherited from dundas.controls.DataControl.
isAligning Gets or sets a value indicating whether the control is currently being aligned. Inherited from dundas.controls.DataControl.
isClickEventSelectionEnabled Gets or sets whether click events will trigger the selection feature.
isDrawPending Gets a value indicating whether the control is about to re-draw. Inherited from dundas.controls.DataControl.
isEmptyDataHidden Gets or sets a value indicating whether pre-set punctuation is hidden when the data source is empty.
isHovered Gets or sets whether the data label should be displayed as hovered over.
isKeywordValueChangesHighlighted Gets or sets whether this control should perform highlight animations when the values of measures associated to keywords in the text are changed.
isRenderedAsHTML Gets or sets whether the text should be rendered as HTML.
isSelected Gets or sets whether the data label should be displayed as selected.
isWhitespaceIgnored Gets or sets whether regular line-breaks and extra spaces are skipped when rendering.
keywordValueChangeHighlightColor Gets or sets the highlight color to apply to the background during keyword change animations.
keywordValueChangeHighlightDuration Gets or sets the length of the animation performed when a text keyword value changes.
legend Gets or sets the legend used by this control. Inherited from dundas.controls.DataControl.
lightFontColor Gets or sets the font color used to contrast against dark colors from color rules.
padding Gets or sets the padding reserved between the boundaries of the control and its content. Inherited from dundas.controls.DataControl.
selectedBackground Gets or sets the background color of the data label when the control is selected.
selectedFontColor Gets or sets the font color of the data label when the control is selected.
stateStyles Gets the set of styles to be applied to the data label conditionally based on the data's current state.
text Gets or sets the text of the data label, which can include placeholder keywords.
textOverflow Gets or sets how overflowed content should be rendered by this control.
textWrap Gets or sets a value indicating whether text can be wrapped onto multiple lines.
tooltip Gets or sets the tooltip of this data label.
tooltipMouseDelay Gets or sets the tooltip of this data label.
verticalTextAlignment Gets or sets the vertical alignment of text.
width Gets the current rendered width of the control. Inherited from dundas.controls.DataControl.
 
 

Methods

 
  Name Description
addStyle Adds a style to the indicator.
alignHorizontallyWith Aligns the content of this control horizontally with the specified control. Inherited from dundas.controls.DataControl.
alignVerticallyWith Aligns the content of this control vertically with the specified control. Inherited from dundas.controls.DataControl.
clearHorizontallyAligned Removes all controls from horizontal alignment with this instance. Inherited from dundas.controls.DataControl.
clearVerticallyAligned Removes all controls from vertical alignment with this instance. Inherited from dundas.controls.DataControl.
draw Re-draws the data control immediately if invalidated. This method is normally called automatically when needed. Inherited from dundas.controls.DataControl.
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
getCurrentStyle Returns the current style for the indicator. If the current style ID does not match any of the state styles or conditional formatting is disabled then the default style is returned.
getDisplayedText Returns the text displayed by this control with the keywords replaced.
getHorizontallyAligned Gets an array of controls set to be horizontally aligned with this control. Inherited from dundas.controls.DataControl.
getVerticallyAligned Gets an array of controls set to be vertically aligned with this control. Inherited from dundas.controls.DataControl.
hitTest Determines what data control element is represented at the specified position. Inherited from dundas.controls.DataControl.
invalidate Ensures the data control is re-drawn using the current data and settings at the next best time made available by the browser. This method is normally called automatically when needed. Inherited from dundas.controls.DataControl.
invalidateSize Notifies the control that its container element size may have changed. Inherited from dundas.controls.DataControl.
isAlignedHorizontallyWith Gets a value indicating whether the specified control has been aligned horizontally with this instance. Inherited from dundas.controls.DataControl.
isAlignedVerticallyWith Gets a value indicating whether the specified control has been aligned vertically with this instance. Inherited from dundas.controls.DataControl.
onDOMDetach Called when the DOM element this control will render to is temporarily detached. Inherited from dundas.controls.DataControl.
onDOMReattach Called when the DOM element this control will render to is re-attached. Inherited from dundas.controls.DataControl.
onKeywordValueChanged Triggers the keyword value changed animation.
removeHorizontallyAligned Removes the specified control from the list to be horizontally aligned with this control. Inherited from dundas.controls.DataControl.
removeStyle Removes a style from the state indicator.
removeVerticallyAligned Removes the specified control from the list to be vertically aligned with this control. Inherited from dundas.controls.DataControl.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.