User Tools

Site Tools


TGIS_ControlLegend class

DK11 for Delphi | FMX.GisControlLegend.TGIS_ControlLegend | Classes | Constructors | Methods | Properties | Events

Visual Legend component.

Available also on: .NET WinForms | Java | ActiveX | Python.


// Delphi
  TGIS_ControlLegend = class( TStyledControl, IGIS_LegendParent, IGIS_PrintableControl )
// C++ Builder
class PASCALIMPLEMENTATION TGIS_ControlLegend : public TStyledControl


→ TStyledControl



Inherited Overrides Protected
Name Visibility Description
Create public Constructor, creates an instance.
Destroy public Destructor, destroys the instance.


Inherited Overrides Protected
Name Visibility Description
Collapse(IGIS_HierarchyGroup) public Collapses a legend item corresponding to a hierarchy group.
Collapse(IGIS_HierarchyGroup; Boolean; Boolean) public Collapses a legend item corresponding to a hierarchy group.
Collapse(TGIS_Layer) public Collapses a legend item corresponding to a layer.
ControlClientHeight protected Gets client height.
(Implements IGIS_LegendParent.ControlClientHeight)
ControlClientWidth protected Gets client width.
(Implements IGIS_LegendParent.ControlClientWidth)
ControlDragCreateTemporaryContext protected Creates temporary context to avoid flickering.
(Implements IGIS_LegendParent.ControlDragCreateTemporaryContext)
ControlDragDrawBar protected Draws drag bar.
(Implements IGIS_LegendParent.ControlDragDrawBar)
ControlDragDrawNode protected Draws drag bitmap.
(Implements IGIS_LegendParent.ControlDragDrawNode)
ControlDragFreeNode protected Frees a node for dragging.
(Implements IGIS_LegendParent.ControlDragFreeNode)
ControlDragPrepareNode protected Draws a node for dragging.
(Implements IGIS_LegendParent.ControlDragPrepareNode)
ControlDragRenderTemporaryContext protected Renders temporary context and destroy it.
(Implements IGIS_LegendParent.ControlDragRenderTemporaryContext)
ControlDrawFromCache protected Draws cache.
(Implements IGIS_LegendParent.ControlDrawFromCache)
ControlDrawNode protected Draws a node.
(Implements IGIS_LegendParent.ControlDrawNode)
ControlFullUpdate protected Causes repaint of the entire control.
(Implements IGIS_LegendParent.ControlFullUpdate)
ControlGetHScrollPosition protected Gets horizontal scrollbar position.
(Implements IGIS_LegendParent.ControlGetHScrollPosition)
ControlGetVScrollPosition protected Gets vertical scrollbar position.
(Implements IGIS_LegendParent.ControlGetVScrollPosition)
ControlHeight protected Gets control height.
(Implements IGIS_LegendParent.ControlHeight)
ControlIsDesignMode protected Checks if the control is in design mode.
(Implements IGIS_LegendParent.ControlIsDesignMode)
ControlRenderer protected Gets renderer instance.
(Implements IGIS_LegendParent.ControlRenderer)
ControlRepaint protected Repaints the control.
(Implements IGIS_LegendParent.ControlRepaint)
ControlRightToLeft protected Checks if the control is in 'right to left' mode.
(Implements IGIS_LegendParent.ControlRightToLeft)
ControlSetHScroll protected Sets horizontal scrollbar range & position.
(Implements IGIS_LegendParent.ControlSetHScroll)
ControlSetHScrollPosition protected Sets horizontal scrollbar position.
(Implements IGIS_LegendParent.ControlSetHScrollPosition)
ControlSetVScroll protected Sets vertical scrollbar range & position.
(Implements IGIS_LegendParent.ControlSetVScroll)
ControlSetVScrollPosition protected Sets vertical scrollbar position.
(Implements IGIS_LegendParent.ControlSetVScrollPosition)
ControlStyleCreateTemporaryContext protected Creates temporary context.
(Implements IGIS_LegendParent.ControlStyleCreateTemporaryContext)
ControlStyleDrawCheckBox protected Draws a check box.
(Implements IGIS_LegendParent.ControlStyleDrawCheckBox)
ControlStyleDrawExpandCollapseMarker protected Draws an expand/collapse marker.
(Implements IGIS_LegendParent.ControlStyleDrawExpandCollapseMarker)
ControlStyleDrawImage protected Draws image on temporary context.
(Implements IGIS_LegendParent.ControlStyleDrawImage)
ControlStyleDrawRectangle(Integer; Integer; Integer; Integer; TGIS_Color; TGIS_Color) protected Draws a rectangle.
(Implements IGIS_LegendParent.ControlStyleDrawRectangle)
ControlStyleDrawRectangle(TRect) protected Draws a rectangle.
(Implements IGIS_LegendParent.ControlStyleDrawRectangle)
ControlStyleDrawText protected Draws text.
(Implements IGIS_LegendParent.ControlStyleDrawText)
ControlStyleGetColor protected Gets background color.
(Implements IGIS_LegendParent.ControlStyleGetColor)
ControlStyleGetTextExtent protected Gets text extent.
(Implements IGIS_LegendParent.ControlStyleGetTextExtent)
ControlStyleRenderTemporaryContext protected Renders temporary context and destroy it.
(Implements IGIS_LegendParent.ControlStyleRenderTemporaryContext)
ControlStyleSetColor protected Sets background color.
(Implements IGIS_LegendParent.ControlStyleSetColor)
ControlSubscribedUpdate protected Does subscribed update.
(Implements IGIS_LegendParent.ControlSubscribedUpdate)
ControlTouch protected Passes the touch event context.
(Implements IGIS_LegendParent.ControlTouch)
ControlUpdate protected Does update.
(Implements IGIS_LegendParent.ControlUpdate)
ControlWidth protected Gets control width.
(Implements IGIS_LegendParent.ControlWidth)
CreateCopy public Prepare a copy of the control for printing.
(Implements IGIS_PrintableControl.CreateCopy)
DoMouseLeave protected
DrawBmp public Draw control on a provided bitmap.
Expand(IGIS_HierarchyGroup) public Expands of a legend item associated with the specific hierarchy group.
Expand(IGIS_HierarchyGroup; Boolean; Boolean) public Expands a legend item corresponding to a hierarchy group.
Expand(TGIS_Layer) public Expands a legend item associated with the specific layer.
FreeCopy public Release the copy of the control.
(Implements IGIS_PrintableControl.FreeCopy)
InvalidateItems public Forces invalidation of all the legend items.
IsExpanded(IGIS_HierarchyGroup) public Checks if the legend item is associated with the specific hierarchy group is expanded.
IsExpanded(TGIS_Layer) public Checks if the legend item is associated with the specific layer is expanded.
KeyDown protected Overrides the default KeyDown event behavior.
MouseDown protected Overrides the default MouseDown event behavior.
MouseMove protected Overrides the default MouseMove event behaviour.
MouseUp protected Overrides the default MouseUp event behaviour.
MouseWheel protected Overrides the default MouseWheel event behaviour.
Paint protected
Painting protected
PrintBmp public Print the control on the given bitmap.
(Implements IGIS_PrintableControl.PrintBmp)
PrintClipboard public Prints the current state of the legend to the clipboard as a bitmap.
Resize protected
TapDouble protected Event handler of the double tap action.
TapLong protected Event handler of the long tap action.
TapSingle protected Event handler of the single tap action.


Inherited Protected
Name Visibility Description
Align published Standard FMX property.
Anchors published Standard FMX property.
BackgroundColor published Background color.
BiDiMode published BiDi value.
BiDiModeFromTranslation published Defines which BiDi will be used: the one from property or the one from translation
ClipChildren published Standard FMX property.
ClipParent published Standard FMX property.
CompactView published If True then the legend view is compacted - icons are smaller.
Cursor published Standard FMX property.
DialogOptions published Options defining dialogs behavior.
DragMode published Standard FMX property.
Enabled published Standard FMX property.
EnableDragHighlight published Standard FMX property.
Font published Display font.
FontColor published Display font.
GIS_Group public Selected group.
GIS_Layer public Selected layer.
GIS_Viewer published Attached IGIS_Viewer object.
Height published Standard FMX property.
HitTest published Standard FMX property.
InternalName public Used for internal use of TatukGIS.
(Implements IGIS_PrintableControl.InternalName)
Locked published Standard FMX property.
Margins published Standard FMX property.
Mode published Mode of the legend - list of layers or grouped tree view.
Opacity published Standard FMX property.
Options published Options of the legend.
Padding published Standard FMX property.
PopupMenu published Standard FMX property.
Position published Standard FMX property.
ReverseOrder published True if the order of legend entries in the Layer mode should be reverse, i.e.
RotationAngle published Standard FMX property.
RotationCenter published Standard FMX property.
Scale published Standard FMX property.
SelectedNode protected Selected node.
Size published Standard FMX property.
TabOrder published Standard FMX property.
Visible published Standard FMX property.
Width published Standard FMX property.


Inherited Protected
Name Visibility Description
GroupActiveChangeEvent published Event fired when a group is activated/deactivated.
GroupSelectEvent published Event fired upon group selection.
LayerActiveChangeEvent published Event fired when a layer is activated/deactivated.
LayerParamsChangeEvent published Event fired when a layer parameters get changed.
LayerSelectEvent published Event fired upon layer selection.
OnClick published Standard FMX event.
OnDblClick published Standard FMX event.
OnDragDrop published Standard FMX event.
OnDragEnd published Standard FMX event.
OnDragEnter published Standard FMX event.
OnDragLeave published Standard FMX event.
OnDragOver published Standard FMX event.
OnMouseDown published Standard FMX event.
OnMouseEnter published Standard FMX event.
OnMouseLeave published Standard FMX event.
OnMouseMove published Standard FMX event.
OnMouseUp published Standard FMX event.
OnMouseWheel published Standard FMX event.
OnPaint published Standard FMX event.
OnPainting published Standard FMX event.
OnResize published Standard FMX event.
OpenDialogEvent published Event fired upon opening of the layer properties dialog box.
OrderChangeEvent published Event fired upon a change of the order of layers.
TapDoubleEvent published TapDouble event.
TapLongEvent published TapLong event.
TapSimpleEvent published TapSimple event.


Place this component on a form and connect GIS_Viewer to IGIS_Viewer object. Selected layer is available via GIS_Layer property.


2023/05/26 01:09

Page Tools