ChartDirector 6.0 (C++ Edition)

ImageMapHandler.getKey


Usage

const char *getKey(int i);

Description

Gets the key of an attribute of the current hot spot.

Each hot spot is associated with an arbitrary number of attributes, in which each attribute consists of a key and a value. This method returns the key of the (i + 1)th attribute. (The first attribute is 0, while the nth attribute is n - 1.)

If the argument i is equal or larger than the number of attributes, an null string will be returned. This behaviour can be used to enumerate the attributes and to determine how many attributes are associated for the hot spot.

Arguments

ArgumentDefaultDescription
i(Mandatory)The index of the attribute to retrieve (index of first attribute is 0).

Return Value

A string representing the key of the attribute, or null if there is no such attribute.