CDImageMapHandlerMBS.Constructor(ImageMap as string)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Constructs an image map handler object for the given image map.

Argument	Default	Description
imageMap	(Mandatory)	A text string representing the image map in HTML format.

CDImageMapHandlerMBS.getHotSpot(xCoordinate as double, yCoordinate as double) as integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets the hot spot under the given point as the current hot spot.

This method will retrieve the hot spot under the given point as the "current hot spot". Its attributes can then be retrieved using ImageMapHandler.getKey, ImageMapHandler.getValue and ImageMapHandler.getValue2.

This method returns an integer representing the hot spot, or -1 if the point is not over any hot spot. Each hot spot region is represented by a unique integer, which can be any arbitrary number. The number is mainly used to determine if the cursor has changed from one hot spot to another hot spot.

Argument	Default	Description
x	(Mandatory)	The x coordinate of a point of which the hot spot is to be retrieved.
y	(Mandatory)	The y coordinate of a point of which the hot spot is to be retrieved.

Return Value
An integer representing the hot spot, or -1 if the given point is not over any hot spot.

Some examples using this method:

• /ChartDirector/ChartDirector Control
• /ChartDirector/ChartDirector Control for Web
• /ChartDirector/ChartDirector Control Retina
• /ChartDirector/finance with ChartDirector Control
• /ChartDirector/math function plot
• /ChartDirector/math function plot centered
• /ChartDirector/math function plot centered and axes
• /ChartDirector/RealTime ViewPort
• /ChartDirector/simplebar with ImageMapHandler
• /ChartDirector/symbolline zoom improved

CDImageMapHandlerMBS.getKey(i as Integer) as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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.

Argument	Default	Description
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.

Some examples using this method:

• /ChartDirector/ChartDirector Control
• /ChartDirector/ChartDirector Control for Web
• /ChartDirector/ChartDirector Control Retina
• /ChartDirector/finance with ChartDirector Control
• /ChartDirector/math function plot
• /ChartDirector/math function plot centered
• /ChartDirector/math function plot centered and axes
• /ChartDirector/simplebar with ImageMapHandler
• /ChartDirector/symbolline zoom improved

CDImageMapHandlerMBS.getValue(i as Integer) as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets the value of an attribute of the current hot spot by using its numeric index.

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 value of the (i + 1)th attribute. (The first attribute is 0, while the nth attribute is n - 1.)

Argument	Default	Description
i	(Mandatory)	The index of the attribute to retrieve (index of first attribute is 0).

Return Value
A string representing the value of the attribute, or null if there is no such attribute.

See also:

• getValue(key as string) as string

CDImageMapHandlerMBS.getValue(key as string) as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets the value of an attribute of the current hot spot by using its key.

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 value of the attribute given the key.

Argument	Default	Description
key	(Mandatory)	A text string representing the key of the attribute.

Return Value
A string representing the value of the attribute, or null if there is no such attribute.

See also:

• getValue(i as Integer) as string