ScaleAxis Class TIBCO Spotfire 7.6 API Reference
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

SystemObject
  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

  NameDescription
Protected methodCreateEventRelay(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.)
Protected methodCreateEventRelay(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.)
Protected methodCreatePropertyT(PropertyName, UndoableListT) (Inherited from DocumentNode.)
Protected methodCreatePropertyT(PropertyName, UndoableSetT) (Inherited from DocumentNode.)
Protected methodCreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) (Inherited from DocumentNode.)
Protected methodCreatePropertyT(PropertyName, UndoablePropertyT, T) (Inherited from DocumentNode.)
Protected methodCreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) (Inherited from DocumentNode.)
Protected methodCreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodCreateReadOnlyPropertyT
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.)
Protected methodCreateRuntimeConstantT
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.)
Protected methodCreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT) Obsolete. (Inherited from DocumentNode.)
Protected methodCreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT) (Inherited from DocumentNode.)
Protected methodDeclareInternalEventHandlers
Override this method to declare handlers of internal events.
(Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) (Inherited from DocumentNode.)
Protected methodDeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodDeserializeReadOnlyPropertyT
Deserializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected methodDuplicateSubtreeT
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.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetPersistedTypeName
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.)
Protected methodGetPersistedVersion
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.)
Protected methodGetService
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.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInternalTransaction
Starts an internal transaction on the document model by executing the specified executor delegate.
(Inherited from DocumentNode.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnConfigure
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnConfigured
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnReconfigure
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnReconfigured
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT)
Serializes an Undoable*Property with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableListT)
Serializes an UndoableList with values of type T storing it in info with key list.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT)
Serializes an UndoableProperty with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT)
Serializes an UndoableSet storing it in info with key given by the property name of the set.
(Inherited from DocumentNode.)
Protected methodSerializePropertyTKey, 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.)
Protected methodSerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodSerializeReadOnlyPropertyT
Serializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected methodValidateAttached
Validates that the node is attached.
(Inherited from DocumentNode.)
Top
Properties

  NameDescription
Public propertyAxisMode
Gets or sets the axis mode.
(Inherited from Axis.)
Public propertyBinding
Gets or sets the axis binding.
(Inherited from Axis.)
Public propertyCategorical
Gets the categorical axis.
(Inherited from ScaleAxisBase.)
Public propertyCategoryMode
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.)
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyContinuous
Gets the continuous axis.
(Inherited from ScaleAxisBase.)
Public propertyErrorBars
Gets the error bars.
Public propertyEvaluationMode
Gets or sets a value controlling whether the axis expression should be evaluated on all data or on filtered data.
(Inherited from Axis.)
Public propertyCode exampleExpression
Gets or sets the expression that defines how data is mapped to this axis.
(Inherited from Axis.)
Public propertyIncludeZeroInAutoZoom
Controls if zero should be included on numeric range when auto zooming.
(Inherited from ScaleAxisBase.)
Public propertyIndexedIncludeZeroInAutoZoom
Controls the IncludeZeroInAutoZoom for individual scales.
(Inherited from ScaleAxisBase.)
Public propertyIndexedRange
Controls the Range for individual scales.
(Inherited from ScaleAxisBase.)
Public propertyIndexedReversed
Reverses the axis for individual scales. The returned indexedBool can be used to set and get reverse for individual scales.
(Inherited from ScaleAxisBase.)
Public propertyIndexedTransformType
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.)
Public propertyIndividualScaling
Enables individual scaling.
(Inherited from ScaleAxisBase.)
Public propertyIndividualScalingMode
Gets or sets the scaling mode that defines what the individual scaling is based on.
(Inherited from ScaleAxisBase.)
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyManualZoom
Controls whether this axis automatically zooms to show the filtered data, or zooms manually using the ZoomRange.
(Inherited from ScaleAxisBase.)
Public propertyName
Gets the axis name.
(Inherited from Axis.)
Public propertyRange
Gets or sets the overall range of this axis.
(Inherited from ScaleAxisBase.)
Public propertyReversed
Gets or sets the value indicating whether the axis is reversed.
(Inherited from ScaleAxisBase.)
Public propertyScale
Gets the scale properties.
Public propertyScaleLabels
Gets the scale labels object.
Public propertyShowAllCategories 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.)
Public propertyShowAxisSelector
Gets or sets a value indicating whether an axis selector should be shown for this axis.
(Inherited from ScaleAxisBase.)
Public propertyTitleFont
Gets or sets the title font.
(Inherited from ScaleAxisBase.)
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyTransformType
Represents the axis transformation type.
(Inherited from ScaleAxisBase.)
Public propertyUseLogTransform Obsolete.
Gets or sets a value indicating whether to use log transform.
(Inherited from ScaleAxisBase.)
Public propertyZoomRange
Get or sets the visible range of the axis.
(Inherited from ScaleAxisBase.)
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodIServiceProviderGetService
Implements IServiceProvider.
(Inherited from Node.)
Explicit interface implementationPrivate methodINodeContextGetAncestorT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Top
Remarks

The visualization type defines the axis characteristics.

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

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference