Represents an X or Y axis in a visualization. It is used to map values
to an axis, typically by applying a range. When mapping, the scale axis
can transform the values.
Inheritance Hierarchy
Spotfire.Dxp.Framework.DocumentModelNode
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.Application.VisualsAxis
Spotfire.Dxp.Application.VisualsScaleAxisBase
Spotfire.Dxp.Application.VisualsScaleAxis
Namespace: Spotfire.Dxp.Application.Visuals
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(13, 0)] public sealed class ScaleAxis : ScaleAxisBase, IRenderableAxis, IImageAxis
The ScaleAxis type exposes the following members.
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(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT) | Obsolete.
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) | |
CreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT) |
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.) | |
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 | Override this method to provide services accessible
from this node and its descendants.
If you can not provide the requested service, you should call
base.GetService which relays the request to the owner
or to the AnalysisApplication if no owner is set.
(Inherited from Node.) | |
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.) | |
ValidateAttached | Validates that the node is attached.
(Inherited from DocumentNode.) |
Properties
Name | Description | |
---|---|---|
AxisMode | Gets or sets the axis mode.
(Inherited from Axis.) | |
Binding | Gets or sets the axis binding.
(Inherited from Axis.) | |
Categorical | Gets the categorical axis.
(Inherited from ScaleAxisBase.) | |
CategoryMode | Gets or sets a value controlling how a categorical axis responds to filtering.
This property only affects axes where the categories are laid out spatially.
(Inherited from Axis.) | |
Context |
Gets the context of this node.
(Inherited from DocumentNode.) | |
Continuous | Gets the continuous axis.
(Inherited from ScaleAxisBase.) | |
ErrorBars | Gets the error bars.
| |
EvaluationMode |
Gets or sets a value controlling whether the axis expression should be evaluated on all data or
on filtered data.
(Inherited from Axis.) | |
Expression | Gets or sets the expression that defines how data is mapped to this axis.
(Inherited from Axis.) | |
IncludeZeroInAutoZoom | Controls if zero should be included on numeric range when auto zooming.
(Inherited from ScaleAxisBase.) | |
IndexedIncludeZeroInAutoZoom | Controls the IncludeZeroInAutoZoom for individual scales. (Inherited from ScaleAxisBase.) | |
IndexedRange | Controls the Range for individual scales. (Inherited from ScaleAxisBase.) | |
IndexedReversed |
Reverses the axis for individual scales. The returned indexedBool can
be used to set and get reverse for individual scales.
(Inherited from ScaleAxisBase.) | |
IndexedTransformType | Represents the axis transformation type for individual scales.
The returned indexedTransformType can be used to set and get the
axisTransformType for individual scales. (Inherited from ScaleAxisBase.) | |
IndividualScaling | Enables individual scaling. (Inherited from ScaleAxisBase.) | |
IndividualScalingMode |
Gets or sets the scaling mode that defines what the individual scaling is based on.
(Inherited from ScaleAxisBase.) | |
IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) | |
ManualZoom | Controls whether this axis automatically zooms to show the filtered data,
or zooms manually using the ZoomRange.
(Inherited from ScaleAxisBase.) | |
Name | Gets the axis name.
(Inherited from Axis.) | |
Range | Gets or sets the overall range of this axis.
(Inherited from ScaleAxisBase.) | |
Reversed | Gets or sets the value indicating whether the axis is reversed. (Inherited from ScaleAxisBase.) | |
Scale | Gets the scale properties.
| |
ScaleLabels |
Gets the scale labels object.
| |
ShowAllCategories | Obsolete. Gets or sets a value indicating whether to show all categories or not.
This property only affects categorical axes where the categories are laid out spatially.
If set to true, categories that are filtered out will still be visible.
(Inherited from Axis.) | |
ShowAxisSelector | Gets or sets a value indicating whether an axis selector should be shown for this axis.
(Inherited from ScaleAxisBase.) | |
TitleFont |
Gets or sets the title font.
(Inherited from ScaleAxisBase.) | |
Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) | |
TransformType |
Represents the axis transformation type.
(Inherited from ScaleAxisBase.) | |
UseLogTransform | Obsolete. Gets or sets a value indicating whether to use log transform.
(Inherited from ScaleAxisBase.) | |
ZoomRange | Get or sets the visible range of the axis.
(Inherited from ScaleAxisBase.) |
Explicit Interface Implementations
Name | Description | |
---|---|---|
IServiceProviderGetService |
Implements IServiceProvider.
(Inherited from Node.) | |
INodeContextGetAncestorT |
Implements GetAncestorT.
(Inherited from DocumentNode.) | |
INodeContextGetServiceT |
Implements GetServiceT.
(Inherited from DocumentNode.) | |
INodeContextIsDescendantOf |
Implements IsDescendantOf(DocumentNode).
(Inherited from DocumentNode.) | |
ITransactionsBeginAggregatedTransaction |
Implements BeginAggregatedTransaction.
(Inherited from DocumentNode.) | |
ITransactionsExecuteInvisibleTransaction |
Implements ExecuteInvisibleTransaction(Executor).
(Inherited from DocumentNode.) | |
ITransactionsExecuteStickyTransaction |
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.) | |
ITransactionsExecuteTransaction |
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.) |
Remarks
The scale axis always has only one Scale, which is used to control how the scale is drawn in the user interface. It can nevertheless implement multiple scales for the Y axis in scatter plots and line charts. Multiple scales is a way to set different transforms and ranges for subsets of data in the data set.
Version Information
See Also