SupportInteractivityAttribute Class

Specifies whether data items in a data section support interactivity.

Namespace : DevExpress.DashboardCommon

Assembly : DevExpress.Dashboard.v25.2.Core.dll

NuGet Package : DevExpress.Dashboard.Core

Declaration

C#
VB.NET

csharp

[AttributeUsage(AttributeTargets.Property)]
public class SupportInteractivityAttribute :
    Attribute

<AttributeUsage(AttributeTargets.Property)>
Public Class SupportInteractivityAttribute
    Inherits Attribute

Remarks

You can apply SupportInteractivityAttribute to a data section when you create metadata for a custom dashboard item. The attribute identifies that a custom item supports interactivity for data items in a data section.

The following code snippet enables interactivity for the Arguments data section in a Funnel custom item:

C#
VB.NET

csharp

using System.ComponentModel;
using DevExpress.DashboardCommon;

namespace CustomItemsSample {
  [DisplayName("Funnel"),
  CustomItemDescription("Funnel description"),
  CustomItemImage("CustomItemsSample.Images.Funnel.svg")]
  public class CustomFunnelMetadata : CustomItemMetadata{
     [DisplayName("Value"),
      EmptyDataItemPlaceholder("Value"),
      SupportColoring(DefaultColoringMode.Hue)]
      public Measure Value {
          get { return GetPropertyValue<Measure>(); }
          set { SetPropertyValue(value); }
      }
      [DisplayName("Arguments"),
      EmptyDataItemPlaceholder("Argument"),
      SupportColoring(DefaultColoringMode.Hue),
      SupportInteractivity]
      public DimensionCollection Arguments { get; } = new DimensionCollection();
  }
}

Imports System.ComponentModel
Imports DevExpress.DashboardCommon

Namespace CustomItemsSample
  <DisplayName("Funnel"), CustomItemDescription("Funnel description"), CustomItemImage("Funnel.svg")>
  Public Class CustomFunnelMetadata
      Inherits CustomItemMetadata
      <DisplayName("Value"), EmptyDataItemPlaceholder("Value"), SupportColoring(DefaultColoringMode.Hue)>
      Public Property Value() As Measure
          Get
              Return GetPropertyValue(Of Measure)()
          End Get
          Set(ByVal value As Measure)
              SetPropertyValue(value)
          End Set
      End Property
      <DisplayName("Arguments"), EmptyDataItemPlaceholder("Argument"), SupportColoring(DefaultColoringMode.Hue), SupportInteractivity>
      Public ReadOnly Property Arguments() As New DimensionCollection()
  End Class
End Namespace

Note

If you support interactivity for multiple data sections, all interactive Dimension properties with the SupportInteractivityAttribute must be declared first in the metadata class. To ensure that interactivity works correctly for all data sections, declare all properties with this attribute consecutively.

The Master Filtering and Drill-Down buttons appear in the Data ribbon tab page’s Interactivity group for a custom item.

Use the CustomControlProviderBase.Interactivity property to manage interactivity options.

Inheritance

Object Attribute SupportInteractivityAttribute