Maptitude GISDK Help

GetThemeOptions()

Summary

Gets a list of options for a theme.

 

Syntax

options = GetThemeOptions(string theme_name)

 

Argument

Contents

theme_name

The name of the theme

 

Returns

A name-value array of options containing both of the following options, plus additional option pairs as appropriate for the type of theme:

 

Option

Type

Contents

Data Source

String

Indicates which data were scanned to determine the minimum and maximum values. If "All" all features were scanned; if "Screen" only features appearing on the screen in the current map were scanned

Title

String

Title of the theme, as it appears in the legend

For Chart Themes

Option

Type

Contents

Direction

String

Whether bar or stack charts are "Vertical" or "Horizontal"

Minimum Value

Real

Features with values below the mimimum are displayed at minimum size

Maximum Value

Real

Features with values above the maximum are displayed at maximum size

Minimum Size

Real

Minimum pie diameter or total bar length (in points) corresponding to the minimum value (defaults to 0)

Maximum Size

Real

Maximum pie diameter or total bar length (in points) corresponding to the maximum value (defaults to 54)

Width

Real

The bar or stack chart width in points (defaults to 14)

3D

Boolean

Whether bar or stack charts are drawn with 3-D effects (defaults to "False")

For Class Themes

Option

Type

Contents

Direction

String

Whether the class values in a progression theme are "Decreasing" or "Increasing"

Drop Empty Classes

Boolean

Whether classes containing zero features should be dropped from the theme

Force Value

Real

Forces a break between classes at the specified value (Numeric Categories, Equal Steps, Equal Weight, Quantiles, Standard Deviation

Include Maximum

Boolean

Whether the maximum value is included or excluded from the range of data

Include Minimum

Boolean

Whether the minimum value is included or excluded from the range of data

Maximum Value

Real

The maximum value to include in a class

Minimum Value

Real

The minimum value to include in a class

Other

Boolean

Whether the Other class was included (for features whose values do not fall into any other class)

Pretty Values

Boolean

Whether the high and low values for each class were rounded to make them more presentable (defaults to "False")

Rate

String

The type of rate to use for a progression theme: "Constant", "Decreasing", "Increasing"

Scale

Real

Scaling factor for progression or standard deviation methods

Sort Order

String

If "Descending" classes were created starting with the highest value and working downward; if "Ascending" classes were created starting with the lowest value and working upward (all numeric themes)

Style

Boolean

"True" for a pattern theme; "False" for a color theme

Title

String

Title of the theme, as it appears in the legend

Type

String

The type of progression for a progression theme: "Arithmetic" or "Geometric"

Values

Array

An array containing one element for each class in the theme. The contents of the elements varies by method, as shown in the table below

Weight Field

String

For the equal weight method, the field spec of the numeric field that was used to weight the data values

Zero

Boolean

Whether zero is treated as a missing value (defaults to "False")

 

Method

Contents of the Values Array

Counts

Integers indicating the number of features in each class

Percents

A real number indicating the percentage of features in each class

Manual (string field)

Strings indicating the value for each class

Manual (numeric field)

One of the following: real numbers indicating the value for each class; or an array of {real low_value, boolean low_inclusive, real hi_value, boolean hi_inclusive} indicating the low and high values for each class

For Continuous Themes

Option

Type

Contents

Minimum Value

Real

Features with values below the mimimum are displayed at minimum size

Maximum Value

Real

Features with values above the maximum are displayed at maximum size

Minimum Size

Real

Minimum icon size or line width (in points) corresponding to the minimum value

Maximum Size

Real

Maximum icon size or line width (in points) corresponding to the maximum value

 

Error Codes

Error

Meaning

NotFound

The specified theme does not exist

 

See Also

Function

Summary

GetTheme()

Gets information about a theme

GetThemeStatistics()

Gets statistical information about a color or pattern theme

SetThemeOptions()

Changes some theme options

 

 

©2025 Caliper Corporation www.caliper.com