| Name | Description | |
|---|---|---|
| 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. |
| categoryHeadingAlignment | Gets or sets the category heading alignment. |
| categoryHeadingFontColor | Gets or sets the category heading font color. |
| categoryHeadingFontFamily | Gets or sets the category heading font family. |
| categoryHeadingFontSize | Gets or sets the category heading font size. |
| categoryHeadingFontStyle | Gets or sets the category heading font style. |
| categoryHeadingFontWeight | Gets or sets the category heading font weight. |
| categoryHeadingPadding | Gets or sets the tooltip property. |
| categoryOrientation | Gets or sets the category orientation. |
| categorySortDirection | Gets or sets the category sort direction. |
| colorScaleSettings | Gets or sets settings for customizing the display of a color scale in the legend when shown for color rules. |
| container | Gets the DOM element this control will render to. Inherited from dundas.controls.DataControl. |
| customLegendItems | Gets the set of items to be displayed in this legend according to their specified settings. |
| defaultItemStyle | Gets or sets a style defining the default appearance of legend items displayed in this legend. Some properties may be overridden by visualizations displaying their own items. |
| emptyCategoryName | Gets or sets the category heading name for items with no category. |
| height | Gets the current rendered height of the control. Inherited from dundas.controls.DataControl. |
| 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. |
| isCategoriesWrappedAtEdge | Gets or sets a value that determines if categories wrap. |
| isCategoryHeadingVisible | Gets or sets a value that determines if category headings are visible. |
| isDrawPending | Gets a value indicating whether the control is about to re-draw. Inherited from dundas.controls.DataControl. |
| isItemCheckboxVisible | Gets or sets the visibility of the item checkboxes. |
| isItemMergeEnabled | Gets or sets a value that determines if similar legend items should be merged. |
| isItemsWrappedAtEdge | Gets or sets a value that determines if items wrap. |
| itemAlignment | Gets or sets the item alignment. |
| itemBackground | Gets or sets the background color of the legend items. |
| itemCheckboxMargin | Gets or sets the default spacing between checkboxes and their surrounding content in legend items. |
| itemFontColor | Gets or sets the font color. |
| itemFontFamily | Gets or sets the font family for legend items. |
| itemFontSize | Gets or sets the font size. |
| itemFontStyle | Gets or sets the font style. |
| itemFontWeight | Gets or sets the font weight. |
| itemMarkerMargin | Gets or sets the default spacing between markers and their surrounding content in legend items. |
| itemOrientation | Gets or sets the item orientation. |
| itemPadding | Gets or sets the default padding between legend items and their surrounding content. |
| itemSortDirection | Gets or sets the item sort direction. |
| itemTextAlign | Gets or sets the horizontal alignment of shorter lines of text when wrapped onto multiple lines. |
| itemTextMargin | Gets or sets the default spacing around legend item text. |
| itemTextMaximumWidth | Gets or sets a maximum length for the item's text in pixels before it is wrapped onto multiple lines. |
| itemTextWrap | Gets or sets a value indicating whether legend item text can be wrapped onto multiple lines. |
| legend | Gets or sets the legend used by this control. Inherited from dundas.controls.DataControl. |
| legendAlignment | Gets or sets the alignment of the legend. |
| padding | Gets or sets the padding reserved between the boundaries of the control and its content. Inherited from dundas.controls.DataControl. |
| tooltip | Gets or sets the tooltip property. |
| tooltipMouseDelay | Gets or sets the tooltip delay. |
| width | Gets the current rendered width of the control. Inherited from dundas.controls.DataControl. |
| Name | Description | |
|---|---|---|
 | addCustomItems | Add legend items to the list of custom legend items. |
| addItem | Adds a legend item to the legend. |
| addItemTextMarker | Adds a legend item to the legend. |
| 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. |
| getHorizontallyAligned | Gets an array of controls set to be horizontally aligned with this control. Inherited from dundas.controls.DataControl. |
| getItemById | Get a legend item with a specific ID from the legend. |
| getItemsByOwnerId | Get legend items with a specific owner from the legend. |
| getVerticallyAligned | Gets an array of controls set to be vertically aligned with this control. Inherited from dundas.controls.DataControl. |
| hitTest | Determines what legend items are represented at the specified position. This will usually be a single item but could be more than one if items overlap. |
| 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. |
| invalidateCustomLegendItems | Notifies the legend of changes to the order of customLegendItems. |
| 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. |
| removeCustomItems | Removes each item in the passed array from the list of custom legend items. |
| removeHorizontallyAligned | Removes the specified control from the list to be horizontally aligned with this control. Inherited from dundas.controls.DataControl. |
| removeItemById | Removes legend items with a specific ID from the legend. |
| removeItemsByOwnerId | Removes legend items with a specific owner ID from the legend. |
| 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. |