ScaleLabels.SetLevelSettings Method

ScaleLabels SetLevelSettings Method

TIBCO Spotfire 7.0 API Reference

Sets the scale value renderer type for a hierarchy level on a categorical axis.

Namespace: Spotfire.Dxp.Application.Visuals
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 18.10.8513.5432 (18.10.8513.5432)

Syntax

C++

Copy to Clipboard Print

public void SetLevelSettings(
	string expressionDisplayName,
	TypeIdentifier typeId
)

public void SetLevelSettings(
	string expressionDisplayName,
	TypeIdentifier typeId
)

Parameters

expressionDisplayName: Type: System String
The display name of the expression to be rendered.

typeId: Type: Spotfire.Dxp.Framework.DocumentModel TypeIdentifier
The type id for the renderer.

Remarks

This feature will only have effect on the following axes: Bar chart x axis, Line chart x axis, Combination Chart x axis, Scatter plot x and y axes and Heat map x and y axes, and Cross Table horizontal and vertical axes. For the Cross Table the size can not be set via this API. Instead use the setters for cell and header size avaiable on the Cross Table plot itself. For the case when the axis can be both continuous and categorical, the feature will only have effect when the axis is in categorical mode.

Examples

The way to set a renderer and interact with its settings, assuming that there is an expression with display name "Images" on the current axis, is as follows:

Copy to Clipboard Print

axis.ScaleLabels.SetLevelSettings("Images", ValueRendererTypeIdentifiers.BitmapRenderer);
axis.ScaleLabels["Images"].Size = 40;

axis.ScaleLabels.SetLevelSettings("Images", ValueRendererTypeIdentifiers.BitmapRenderer);
axis.ScaleLabels["Images"].Size = 40;

Copy to Clipboard Print

axis.ScaleLabels.SetLevelSettings("Images", MyValueRendererTypeIdentifiers.MyValueRenderer);
axis.ScaleLabels["Images"].Size = 40;
MyValueRendererSettings mySettings = 
   (MyValueRendererSettings)axis.ScaleLabels["Images"].RendererSettings;
mySettings.MyBestProperty = "Good";

axis.ScaleLabels.SetLevelSettings("Images", MyValueRendererTypeIdentifiers.MyValueRenderer);
axis.ScaleLabels["Images"].Size = 40;
MyValueRendererSettings mySettings = 
   (MyValueRendererSettings)axis.ScaleLabels["Images"].RendererSettings;
mySettings.MyBestProperty = "Good";

and in a more complicated case where the developer needs to use a custom renderer and also interact with its settings:

Version Information

Supported in: 7.0, 6.5, 6.0