Class SfTreeMap

SfTreeMap

Inheritance

System.Object

SfTreeMap

Implements

System.IDisposable

Namespace: Syncfusion.UI.Xaml.TreeMap

Assembly: Syncfusion.SfTreeMap.WPF.dll

Syntax

public class SfTreeMap : Control, IDisposable

Constructors

SfTreeMap()

Constructor

Declaration

public SfTreeMap()

Fields

ColorValuePathProperty

// Using a DependencyProperty as the backing store for ColorValuePath. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ColorValuePathProperty

Field Value

Type
System.Windows.DependencyProperty

DrillDownHeaderHeightProperty

// Using a DependencyProperty as the backing store for DrillDownHeaderHeight. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty DrillDownHeaderHeightProperty

Field Value

Type
System.Windows.DependencyProperty

DrillDownHeaderTemplateProperty

// Using a DependencyProperty as the backing store for DrillDownHeaderTemplate. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty DrillDownHeaderTemplateProperty

Field Value

Type
System.Windows.DependencyProperty

DrillDownSelectionStrokeProperty

// Using a DependencyProperty as the backing store for DrillDownSelectionStroke. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty DrillDownSelectionStrokeProperty

Field Value

Type
System.Windows.DependencyProperty

EnableDrillDownProperty

Using a DependencyProperty as the backing store for EnableDrillDown. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty EnableDrillDownProperty

Field Value

Type
System.Windows.DependencyProperty

GroupColorMappingsProperty

// Using a DependencyProperty as the backing store for GroupColorMapping. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty GroupColorMappingsProperty

Field Value

Type
System.Windows.DependencyProperty

HighlightBorderBrushProperty

// Using a DependencyProperty as the backing store for HighlightBorderBrush. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty HighlightBorderBrushProperty

Field Value

Type
System.Windows.DependencyProperty

HighlightBorderThicknessProperty

// Using a DependencyProperty as the backing store for HighlightBorderThickness. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty HighlightBorderThicknessProperty

Field Value

Type
System.Windows.DependencyProperty

HighlightGroupOnSelectionProperty

// Using a DependencyProperty as the backing store for HighlightGroupOnSelection. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty HighlightGroupOnSelectionProperty

Field Value

Type
System.Windows.DependencyProperty

HighlightHoverBrushProperty

// Using a DependencyProperty as the backing store for HighlightHoverBrush. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty HighlightHoverBrushProperty

Field Value

Type
System.Windows.DependencyProperty

HighlightOnSelectionProperty

// Using a DependencyProperty as the backing store for HighlightOnSelection. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty HighlightOnSelectionProperty

Field Value

Type
System.Windows.DependencyProperty

ItemsLayoutModeProperty

// Using a DependencyProperty as the backing store for ItemsLayoutMode. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ItemsLayoutModeProperty

Field Value

Type
System.Windows.DependencyProperty

ItemsSourceProperty

// Using a DependencyProperty as the backing store for ItemsSource. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ItemsSourceProperty

Field Value

Type
System.Windows.DependencyProperty

LeafColorMappingProperty

// Using a DependencyProperty as the backing store for LeafColorMapping. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty LeafColorMappingProperty

Field Value

Type
System.Windows.DependencyProperty

LeafItemSettingsProperty

// Using a DependencyProperty as the backing store for LeafItemSettings. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty LeafItemSettingsProperty

Field Value

Type
System.Windows.DependencyProperty

LeafLabelPathProperty

// Using a DependencyProperty as the backing store for LeafLabelPath. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty LeafLabelPathProperty

Field Value

Type
System.Windows.DependencyProperty

LeafNodesProperty

// Using a DependencyProperty as the backing store for LeafNodes. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty LeafNodesProperty

Field Value

Type
System.Windows.DependencyProperty

LeafTemplateProperty

// Using a DependencyProperty as the backing store for LeafTemplate. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty LeafTemplateProperty

Field Value

Type
System.Windows.DependencyProperty

LegendProperty

// Using a DependencyProperty as the backing store for Legend. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty LegendProperty

Field Value

Type
System.Windows.DependencyProperty

LevelsProperty

// Using a DependencyProperty as the backing store for Levels. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty LevelsProperty

Field Value

Type
System.Windows.DependencyProperty

SelectedEvent

Event gets raised on the selection.

Declaration

public static readonly RoutedEvent SelectedEvent

Field Value

Type
System.Windows.RoutedEvent

SelectedItemProperty

// Using a DependencyProperty as the backing store for SelectedItem. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SelectedItemProperty

Field Value

Type
System.Windows.DependencyProperty

SelectedItemsProperty

// Using a DependencyProperty as the backing store for SelectedItems. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SelectedItemsProperty

Field Value

Type
System.Windows.DependencyProperty

SelectionModesProperty

// Using a DependencyProperty as the backing store for SelectionModes. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SelectionModesProperty

Field Value

Type
System.Windows.DependencyProperty

ShowToolTipProperty

// Using a DependencyProperty as the backing store for ShowToolTip. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ShowToolTipProperty

Field Value

Type
System.Windows.DependencyProperty

ToolTipShowDurationProperty

Using a DependencyProperty as the backing store for ToolTipShowDuration. This customize the animation duration.

Declaration

public static readonly DependencyProperty ToolTipShowDurationProperty

Field Value

Type
System.Windows.DependencyProperty

ToolTipTemplateProperty

// Using a DependencyProperty as the backing store for ToolTipTemplate. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ToolTipTemplateProperty

Field Value

Type
System.Windows.DependencyProperty

TreeMapResourceDictionaryProperty

Declaration

public static readonly DependencyProperty TreeMapResourceDictionaryProperty

Field Value

Type
System.Windows.DependencyProperty

WeightValuePathProperty

// Using a DependencyProperty as the backing store for WeightValuePath. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty WeightValuePathProperty

Field Value

Type
System.Windows.DependencyProperty

Properties

ColorValuePath

Gets or Sets ColorValuePath

Declaration

public string ColorValuePath { get; set; }

Property Value

Type
System.String

DrillDownHeaderHeight

Gets or Sets DrillDownHeaderHeight

Declaration

public double DrillDownHeaderHeight { get; set; }

Property Value

Type
System.Double

DrillDownHeaderTemplate

Gets or Sets DrillDownHeaderTemplate

Declaration

public DataTemplate DrillDownHeaderTemplate { get; set; }

Property Value

Type
System.Windows.DataTemplate

DrillDownSelectionStroke

Declaration

public Brush DrillDownSelectionStroke { get; set; }

Property Value

Type
System.Windows.Media.Brush

EnableDrillDown

Gets or sets a value to indicate whether the drill down feature should be enabled.

Declaration

public bool EnableDrillDown { get; set; }

Property Value

Type
System.Boolean

GroupColorMappings

Gets or Sets GroupColorMappings

Declaration

public ObservableCollection<GroupColorMapping> GroupColorMappings { get; set; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<GroupColorMapping>

HighlightBorderBrush

Gets or Sets HighlightBorderBrush

Declaration

public Brush HighlightBorderBrush { get; set; }

Property Value

Type
System.Windows.Media.Brush

HighlightBorderThickness

Gets or Sets HighlightBorderThickness

Declaration

public double HighlightBorderThickness { get; set; }

Property Value

Type
System.Double

HighlightGroupOnSelection

Gets or Sets HighlightGroupOnSelection values

Declaration

public bool HighlightGroupOnSelection { get; set; }

Property Value

Type
System.Boolean

HighlightHoverBrush

Gets or Sets HighlightHoverBrush

Declaration

public Brush HighlightHoverBrush { get; set; }

Property Value

Type
System.Windows.Media.Brush

HighlightOnSelection

Gets or Sets HighlightOnSelection

Declaration

public bool HighlightOnSelection { get; set; }

Property Value

Type
System.Boolean

ItemsLayoutMode

Gets or Sets ItemsLayoutMode

Declaration

public TreeMapLayoutMode ItemsLayoutMode { get; set; }

Property Value

Type
TreeMapLayoutMode

ItemsSource

Gets or Sets ItemsSource values

Declaration

public object ItemsSource { get; set; }

Property Value

Type
System.Object

LeafColorMapping

Gets or Sets LeafColorMapping

Declaration

public ColorMapping LeafColorMapping { get; set; }

Property Value

Type
ColorMapping

LeafItemSettings

Gets or Sets LeafItemSettings

Declaration

public LeafItemSettings LeafItemSettings { get; set; }

Property Value

Type
LeafItemSettings

LeafLabelPath

Gets or Sets LeafLabelPath

Declaration

public string LeafLabelPath { get; set; }

Property Value

Type
System.String

LeafNodes

Gets or Sets list of LeafNodes

Declaration

public List<TreeMapLeafNode> LeafNodes { get; }

Property Value

Type
System.Collections.Generic.List<TreeMapLeafNode>

LeafTemplate

Gets or Sets LeafTemplate

Declaration

public DataTemplate LeafTemplate { get; set; }

Property Value

Type
System.Windows.DataTemplate

Legend

Declaration

public TreeMapLegend Legend { get; set; }

Property Value

Type
TreeMapLegend

Levels

Gets or Sets Levels for TreeMap

Declaration

public ObservableCollection<TreeMapLevel> Levels { get; set; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<TreeMapLevel>

SelectedItem

Gets or Sets SelectedItem

Declaration

[Obsolete("This property is obsolete; use SelectedItems instead")]
public object SelectedItem { get; }

Property Value

Type
System.Object

SelectedItems

Gets or Sets SelectedItems

Declaration

public ObservableCollection<object> SelectedItems { get; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<System.Object>

SelectionModes

Gets or Sets SelectionModes

Declaration

public TreeMapSelectionModes SelectionModes { get; set; }

Property Value

Type
TreeMapSelectionModes

ShowToolTip

Gets or Sets ShowToolTip values

Declaration

public bool ShowToolTip { get; set; }

Property Value

Type
System.Boolean

ToolTipShowDuration

Gets or sets the show duration of the tooltip in milliseconds.

Declaration

public int ToolTipShowDuration { get; set; }

Property Value

Type	Description
System.Int32	An integer denotes the duration of animation in milliseconds. The default value is `1000` milliseconds.

ToolTipTemplate

Gets or Sets ToolTipTemplate

Declaration

public DataTemplate ToolTipTemplate { get; set; }

Property Value

Type
System.Windows.DataTemplate

WeightValuePath

Gets or Sets WeightValuePath

Declaration

public string WeightValuePath { get; set; }

Property Value

Type
System.String

Methods

Dispose()

Dispose

Declaration

public void Dispose()

GroupColor(List<TreeMapItem>)

GroupColorMapping for levels

Declaration

public void GroupColor(List<TreeMapItem> items)

Parameters

Type	Name	Description
System.Collections.Generic.List<TreeMapItem>	items

OnApplyTemplate()

Method gets called when the default style key template applied.

Declaration

public override void OnApplyTemplate()

OnCreateAutomationPeer()

Methods to create the automation peer for SfTreeMap class.

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Type	Description
System.Windows.Automation.Peers.AutomationPeer	The automation peer.

OnKeyDown(KeyEventArgs)

Occurs on key down.

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.KeyEventArgs	e	The key event args.

Print()

Method Print gets called to print the visual.

Declaration

public void Print()

RefreshTreeMap()

Method gets called to refresh tree map.

Declaration

public void RefreshTreeMap()

Save(Stream, BitmapEncoder)

Save Treemap

Declaration

public void Save(Stream stream, BitmapEncoder imgEncoder)

Parameters

Type	Name	Description
System.IO.Stream	stream
System.Windows.Media.Imaging.BitmapEncoder	imgEncoder

Save(String)

Method gets called to save the file with the file name.

Declaration

public void Save(string fileName)

Parameters

Type	Name	Description
System.String	fileName	The file name.

SelectItem(Object)

Method gets called to add the selected item.

Declaration

public void SelectItem(object data)

Parameters

Type	Name	Description
System.Object	data	The selected item.

Events

OnPrinting

Event gets raised on printing.

Declaration

public event SfTreeMap.OnPrintingEventHandler OnPrinting

Event Type

Type
SfTreeMap.OnPrintingEventHandler

SelectionChanged

Event gets raised on the selection changed.

Declaration

public event SelectionChangedEventHandler SelectionChanged

Event Type

Type
System.Windows.Controls.SelectionChangedEventHandler

Implements

System.IDisposable