menu

Xamarin.Forms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfTreeMap - Xamarin.Forms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfTreeMap

    Represents the SfTreeMap class. To render this, create an instance of SfTreeMap, and set required properties.

    Inheritance
    System.Object
    SfTreeMap
    Namespace: Syncfusion.SfTreeMap.XForms
    Assembly: Syncfusion.SfTreeMap.XForms.dll
    Syntax
    public class SfTreeMap : View, IParentThemeElement, IThemeElement

    Constructors

    SfTreeMap()

    Initializes a new instance of the SfTreeMap class.

    Declaration
    public SfTreeMap()

    Fields

    ColorValuePathProperty

    Gets or sets the ColorValuePath property. This property is used to set the value path based on color value. This is a bindable property.

    Declaration
    public static readonly BindableProperty ColorValuePathProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    DataSourceProperty

    Gets or sets the DataSource property. This property is used to retrieving data. This is a bindable property.

    Declaration
    public static readonly BindableProperty DataSourceProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    DrilldownHeaderStyleProperty

    Gets or sets the style for the drill down header which is used for zoom out operation.

    Declaration
    public static readonly BindableProperty DrilldownHeaderStyleProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    EnableDrilldownProperty

    Gets or sets the boolean value that indicates whether the drill down is enabled or not.

    Declaration
    public static readonly BindableProperty EnableDrilldownProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    HighlightOnSelectionProperty

    Gets or sets the boolean value that indicates whether the selection should be highlighted for the items in tree map.

    Declaration
    public static readonly BindableProperty HighlightOnSelectionProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    HightlightBorderWidthProperty

    Gets or sets the HighlightBorderWidth property. This property is used to customize the width of highlighted border. This is a bindable property.

    Declaration
    public static readonly BindableProperty HightlightBorderWidthProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    HightlightColorProperty

    Gets or sets the HighlightColor property. This property is used to set the color to highlight the items. This is a bindable property.

    Declaration
    public static readonly BindableProperty HightlightColorProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    ItemsProperty

    Gets or sets the Items property. This property is an observable collection of TreeMapItem. This is a bindable property.

    Declaration
    public static readonly BindableProperty ItemsProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    ItemTemplateProperty

    Gets or sets the Itemtemplate property. This property is used to set data template. This is a bindable property.

    Declaration
    public static readonly BindableProperty ItemTemplateProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    LayoutTypeProperty

    Gets or sets the layoutType property. This proeprty is used to customize the layout for tree map. This is a bindable property.

    Declaration
    public static readonly BindableProperty LayoutTypeProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    LeafItemColorMappingProperty

    Gets or sets the LeafItemColorMapping property. This property is used to set the color mapping for leaf items. This is a bindable property.

    Declaration
    public static readonly BindableProperty LeafItemColorMappingProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    LeafItemSettingsProperty

    Gets or sets the LeafItemSettings property. This property is used to customize the settings for leaf level. This is a bindable property.

    Declaration
    public static readonly BindableProperty LeafItemSettingsProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    LegendSettingsProperty

    Gets or sets the Legendsettings property. This property is used to customize the settings for legends. This is a bindable property.

    Declaration
    public static readonly BindableProperty LegendSettingsProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    LevelsProperty

    Gets or sets the levels property. This property is an observable collection of TreeMaplevel. This is a bindable property.

    Declaration
    public static readonly BindableProperty LevelsProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    SelectedItemsProperty

    Gets or sets the selected items property. This property is an observable collection of object. This is a bindable property.

    Declaration
    public static readonly BindableProperty SelectedItemsProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    SelectionModeProperty

    Gets or sets the selection mode property. This property is used to customize the selection for tree map. This is a bindable property.

    Declaration
    public static readonly BindableProperty SelectionModeProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    ShowTooltipProperty

    Gets or sets the boolean value that indicates whether the tooltip should be enabled for tree map.

    Declaration
    public static readonly BindableProperty ShowTooltipProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    TooltipSettingsProperty

    The TooltipSettings bindable Property.

    Declaration
    public static readonly BindableProperty TooltipSettingsProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    WeightValuePathProperty

    Gets or sets the WeightValuePath property. This property is used to set the value path based on data item. This is a bindable property.

    Declaration
    public static readonly BindableProperty WeightValuePathProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    Properties

    ColorValuePath

    Gets or sets the ColorValuePath property. This property is used to set the value path based on color value. This is a bindable property.

    Declaration
    public string ColorValuePath { get; set; }
    Property Value
    Type
    System.String

    DataSource

    Gets or sets the DataSource property. This property is used to retrieving data. This is a bindable property.

    Declaration
    public object DataSource { get; set; }
    Property Value
    Type
    System.Object

    DrilldownHeaderStyle

    Gets or sets the style for the drill down header which is used for zoom out operation.

    Declaration
    public Style DrilldownHeaderStyle { get; set; }
    Property Value
    Type
    Style

    EnableDrilldown

    Gets or sets a value indicating whether the drill down is enabled or not.

    Declaration
    public bool EnableDrilldown { get; set; }
    Property Value
    Type
    System.Boolean

    HighlightOnSelection

    Gets or sets a value indicating whether the selection should be highlighted for the items in tree map.

    Declaration
    public bool HighlightOnSelection { get; set; }
    Property Value
    Type
    System.Boolean

    HightlightBorderWidth

    Gets or sets the HighlightBorderWidth property. This property is used to customize the width of highlighted border. This is a bindable property.

    Declaration
    public double HightlightBorderWidth { get; set; }
    Property Value
    Type
    System.Double

    HightlightColor

    Gets or sets the HighlightColor property. This property is used to set the color to highlight the items. This is a bindable property.

    Declaration
    public Color HightlightColor { get; set; }
    Property Value
    Type
    Xamarin.Forms.Color

    Items

    Gets or sets the Items property. This property is an observable collection of TreeMapItem. This is a bindable property.

    Declaration
    public ObservableCollection<TreeMapItem> Items { get; set; }
    Property Value
    Type
    System.Collections.ObjectModel.ObservableCollection<TreeMapItem>

    ItemTemplate

    Gets or sets the Itemtemplate property. This property is used to set data template. This is a bindable property.

    Declaration
    public DataTemplate ItemTemplate { get; set; }
    Property Value
    Type
    Xamarin.Forms.DataTemplate

    LayoutType

    Gets or sets the layoutType property. This proeprty is used to customize the layout for tree map. This is a bindable property.

    Declaration
    public LayoutTypes LayoutType { get; set; }
    Property Value
    Type
    LayoutTypes

    LeafItemColorMapping

    Gets or sets the LeafItemColorMapping property. This property is used to set color mapping for leaf items. This is a bindable property.

    Declaration
    public ColorMapping LeafItemColorMapping { get; set; }
    Property Value
    Type
    ColorMapping

    LeafItemSettings

    Gets or sets the LeafItemSettings property. This property is used to customize the settings for leaf level. This is a bindable property.

    Declaration
    public LeafItemSettings LeafItemSettings { get; set; }
    Property Value
    Type
    LeafItemSettings

    LegendSettings

    Gets or sets the Legendsettings property. This property is used to customize the settings for legend. This is a bindable property.

    Declaration
    public LegendSettings LegendSettings { get; set; }
    Property Value
    Type
    LegendSettings

    Levels

    Gets or sets the levels property. This property is an observable collection of TreeMaplevel. This is a bindable property.

    Declaration
    public ObservableCollection<TreeMapLevel> Levels { get; set; }
    Property Value
    Type
    System.Collections.ObjectModel.ObservableCollection<TreeMapLevel>

    SelectedItems

    Gets or sets the selected items property. This property is an observable collection of object. This is a bindable property.

    Declaration
    public ObservableCollection<object> SelectedItems { get; set; }
    Property Value
    Type
    System.Collections.ObjectModel.ObservableCollection<System.Object>

    SelectionMode

    Gets or sets the selection mode property. This property is used to customize the selection for tree map. This is a bindable property.

    Declaration
    public SelectionMode SelectionMode { get; set; }
    Property Value
    Type
    SelectionMode

    ShowTooltip

    Gets or sets a value indicating whether the tooltip should be enabled for tree map.

    Declaration
    public bool ShowTooltip { get; set; }
    Property Value
    Type
    System.Boolean

    TooltipSettings

    Gets or sets the tooltipsettings value to maps.

    Declaration
    public TooltipSetting TooltipSettings { get; set; }
    Property Value
    Type
    TooltipSetting

    WeightValuePath

    Gets or sets the WeightValuePath property. This property is used to set the value path based on data item. This is a bindable property.

    Declaration
    public string WeightValuePath { get; set; }
    Property Value
    Type
    System.String

    Methods

    add_RefreshTreeMap(SfTreeMap.RefreshEventHandler)

    Declaration
    public void add_RefreshTreeMap(SfTreeMap.RefreshEventHandler value)
    Parameters
    Type Name Description
    SfTreeMap.RefreshEventHandler value

    add_TreeMapItemSelected(SfTreeMap.TreeMapItemSelectedEventHandler)

    Declaration
    public void add_TreeMapItemSelected(SfTreeMap.TreeMapItemSelectedEventHandler value)
    Parameters
    Type Name Description
    SfTreeMap.TreeMapItemSelectedEventHandler value

    OnBindingContextChanged()

    This method is used to override the binding context and set the binding context when the properties are changed.

    Declaration
    protected override void OnBindingContextChanged()

    OnSizeRequest(Double, Double)

    This method is overriden from framework view, and this method is used to set the size for the tree map control.

    Declaration
    protected override SizeRequest OnSizeRequest(double widthConstraint, double heightConstraint)
    Parameters
    Type Name Description
    System.Double widthConstraint

    Width Constraint.

    System.Double heightConstraint

    Height Constraint.

    Returns
    Type Description
    Xamarin.Forms.SizeRequest

    SizeRequest.

    OnTreeMapItemSelected(Object)

    This method works when the treemap item selected event is fired and the item is tapped.

    Declaration
    public void OnTreeMapItemSelected(object item)
    Parameters
    Type Name Description
    System.Object item

    To get the item.

    Refresh()

    This method is used to refresh the tree map if any layout or property is updated dynamically.

    Declaration
    public void Refresh()

    remove_RefreshTreeMap(SfTreeMap.RefreshEventHandler)

    Declaration
    public void remove_RefreshTreeMap(SfTreeMap.RefreshEventHandler value)
    Parameters
    Type Name Description
    SfTreeMap.RefreshEventHandler value

    remove_TreeMapItemSelected(SfTreeMap.TreeMapItemSelectedEventHandler)

    Declaration
    public void remove_TreeMapItemSelected(SfTreeMap.TreeMapItemSelectedEventHandler value)
    Parameters
    Type Name Description
    SfTreeMap.TreeMapItemSelectedEventHandler value

    Events

    ItemSelected

    Represents the TreeMapItemSelected Event. This event is fired when the treemap item is selected.

    Declaration
    public event EventHandler<TreeMapItemSelectedEventArgs> ItemSelected
    Event Type
    Type
    System.EventHandler<TreeMapItemSelectedEventArgs>

    RefreshTreeMap

    Represents a new instance of the SfTreeMap.RefreshEventHandler delegate.

    Declaration
    public event SfTreeMap.RefreshEventHandler RefreshTreeMap
    Event Type
    Type
    SfTreeMap.RefreshEventHandler

    TreeMapItemSelected

    Represents the TreeMapItemSelected Event. This event is fired when the treemap item is selected.

    Declaration
    public event SfTreeMap.TreeMapItemSelectedEventHandler TreeMapItemSelected
    Event Type
    Type
    SfTreeMap.TreeMapItemSelectedEventHandler
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved