Base class for legend items contained in a Legend.
Inheritance Hierarchy
Node
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.Application.VisualsLegendItem
More...
Namespace: Spotfire.Dxp.Application.Visuals
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 66.0.19621.1485 (66.0.19621.1485)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(56, 0)] public abstract class LegendItem : DocumentNode
The LegendItem type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | LegendItem | Implements ISerializable. |
Properties
Name | Description | |
---|---|---|
![]() | CanBeHorizontal |
Gets a value indicating whether this item can be placed in the horizontal legend.
|
![]() | Context |
Gets the context of this node.
(Inherited from DocumentNode.) |
![]() | IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) |
![]() | ShowSubItemsInHorizontalLegend | Gets or sets a value whether the sub items will be displayed in the horizontal legend or in the vertical legend.
Only sub items that return true for CanBeHorizontal will show up in the horizontal legend.
|
![]() | ShowTitle | Gets or sets a value indicating whether the title of this
LegendItem is shown.
|
![]() | Title | Gets the title of this legend item.
|
![]() | Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) |
![]() | Visible | Gets or sets a value indicating whether this
LegendItem is visible.
|
Methods
Name | Description | |
---|---|---|
![]() | CreateEventRelay(PropertyName, StatelessDependencyDeclarer) |
Creates an event relay. An event relay is a property in the document model
which propagates event.
An event is raised for the event relay whenever when the trigger returned by the
specified dependencyDeclarer fires.
(Inherited from DocumentNode.) |
![]() | CreateEventRelay(PropertyName, StatelessDependencyDeclarer, EventRelayMode) |
Creates an event relay. An event relay is a property in the document model
which propagates event.
An event is raised for the event relay whenever when the trigger returned by the
specified dependencyDeclarer fires.
(Inherited from DocumentNode.) |
![]() | CreatePropertyT(PropertyName, UndoableListT) |
Creates an UndoableListT and assigns it to the specified field.
The UndoableListT will have the specified propertyName.
(Inherited from DocumentNode.) |
![]() | CreatePropertyT(PropertyName, UndoableSetT) |
Creates an UndoableSetT and assigns it to the specified field.
The UndoableSetT will have the specified propertyName.
(Inherited from DocumentNode.) |
![]() | CreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) |
Creates an UndoableCrossReferencePropertyT and assigns it to the specified field.
The UndoableCrossReferencePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) |
![]() | CreatePropertyT(PropertyName, UndoablePropertyT, T) |
Creates an UndoablePropertyT and assigns it to the specified field.
The UndoablePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) |
![]() | CreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) |
Creates an UndoableDictionaryTKey, TValue and assigns it to the specified field.
The UndoableDictionaryTKey, TValue will have the specified propertyName.
(Inherited from DocumentNode.) |
![]() | CreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) |
Creates an UndoableKeyedCollectionTKey, TNode and assigns it to the specified field.
The UndoableKeyedCollectionTKey, TNode will have the specified propertyName.
(Inherited from DocumentNode.) |
![]() | CreateReadOnlyPropertyT |
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.) |
![]() | CreateRuntimeConstantT |
Creates a runtime constant. A runtime constant is a property in the document model
whose value is computed once when first accessed. The value is then disposed
along with the DocumentNode.
(Inherited from DocumentNode.) |
![]() | CreateRuntimePropertyT |
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) |
![]() | DeclareInternalEventHandlers | Override this method to declare handlers of internal events.
(Inherited from DocumentNode.) |
![]() | DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) |
Deserializes an UndoableCrossReferencePropertyT with value of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
![]() | DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) | (Inherited from DocumentNode.) |
![]() | DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) | (Inherited from DocumentNode.) |
![]() | DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) | (Inherited from DocumentNode.) |
![]() | DeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) | (Inherited from DocumentNode.) |
![]() | DeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) | (Inherited from DocumentNode.) |
![]() | DeserializeReadOnlyPropertyT |
Deserializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
![]() | DuplicateSubtreeT | Returns a copy of the sub tree spanned from this node that
has the same outwards non-owning references. The returned copy will
be in state New and is intended to be attached to the document
immediately. (Inherited from DocumentNode.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetFont | Gets the font.
|
![]() | GetObjectData | Implements ISerializable. (Overrides DocumentNodeGetObjectData(SerializationInfo, StreamingContext).) |
![]() | GetPersistedTypeName | Can be used in the deserialization constructor to get the type name that the class
corresponding to this class had when it was originally serialized. Will return null
if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.) |
![]() | GetPersistedVersion | Can be used in the deserialization constructor to get the persistence version that this class
was marked with when it was originally serialized. Will return null
if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.) |
![]() | GetService | IServiceProvider implementation.
(Overrides Node.GetService(Type).) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | InternalTransaction |
Starts an internal transaction on the document model by
executing the specified executor delegate.
(Inherited from DocumentNode.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | OnConfigure |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) |
![]() | OnConfigured |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) |
![]() | OnReconfigure |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) |
![]() | OnReconfigured |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) |
![]() | SerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT) | Serializes an Undoable*Property with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) |
![]() | SerializePropertyT(SerializationInfo, StreamingContext, UndoableListT) | Serializes an UndoableList with values of type T
storing it in info with key list.Name.
(Inherited from DocumentNode.) |
![]() | SerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT) | Serializes an UndoableProperty with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) |
![]() | SerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT) | Serializes an UndoableSet storing it in info
with key given by the property name of the set.
(Inherited from DocumentNode.) |
![]() | SerializePropertyTKey, TValue(SerializationInfo, StreamingContext, UndoableDictionaryTKey, TValue) | Serializes an UndoableDictionary storing it in info
with key given by the property name of the dictionary.
(Inherited from DocumentNode.) |
![]() | SerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) |
Serializes an UndoableKeyedCollectionTKey, TNode storing it in info
with key given by the property name of the keyedCollection.
(Inherited from DocumentNode.) |
![]() | SerializeReadOnlyPropertyT |
Serializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | ValidateAttached | Validates that the node is attached.
(Inherited from DocumentNode.) |
Explicit Interface Implementations
Version Information
Supported in: 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also
Reference
Inheritance Hierarchy
Node
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.Application.VisualsLegendItem
Spotfire.Dxp.Application.VisualsLegendAxisItem
Spotfire.Dxp.Application.VisualsLegendBoxPlotReferencePointsItem
Spotfire.Dxp.Application.VisualsLegendDataTableItem
Spotfire.Dxp.Application.VisualsLegendFilteringsItem
Spotfire.Dxp.Application.VisualsLegendFilterRuleItem
Spotfire.Dxp.Application.VisualsLegendFittingModelCollectionItem
Spotfire.Dxp.Application.VisualsLegendItemStandIn
Spotfire.Dxp.Application.VisualsLegendLineConnectionItem
Spotfire.Dxp.Application.VisualsLegendMarkingItem
Spotfire.Dxp.Application.VisualsLegendReferenceLinesItem
Spotfire.Dxp.Application.VisualsLegendTextItem
Spotfire.Dxp.Application.VisualsLegendTrellisItem
Spotfire.Dxp.Application.Visuals.MapsLegendWmsStyleItem