Version

xamDoughnutChart - Replay-only Methods

Topic Overview

Purpose

This topic provides information about the xamDoughnutChart™ control’s testable user replay-only methods.

In this topic

This topic contains the following sections:

xamDoughnutChart Test Object Replay-only Methods Summary

Replay-Only methods summary chart

The following table briefly describes the replay-only method for testing the control.

Method Replay action description

GetSliceValue

Returns the value for a given slice.

GetRingSliceCount

Returns the count of all visible slices for a given ring.

GetRingSliceLabels

Returns a delimited string of all visible slices for a given ring.

GetSliceValue action method

Description

This replay action returns the numerical value of the selected slice of the xamDoughnutChart control.

Parameters

The following table describes the method’s parameter followed by code example.

Method parameter Description

oSliceId

Identifies the following elements of the xamDoughnutChart control:

  • The chart’s slice using either the slice’s label or zero-based (integer) index

  • The chart’s ring using 2-dimensional array comprised of a zero-based (integer) index

Example

The following script Returns the value of the “Sales” slice of the doughnut chart on the inner-most ring.

x = XamDoughnutChart("Identifier").GetSliceValue “Sales”
msgbox x

Possible exceptions

The following is the list of possible exceptions to the method and the likely reason causing them.

Exception reasons

  • The specified XamDoughnut Ring index [{1}] is out of range

  • The specified XamDoughnut Slice index [{1}] is out of range

  • The following XamDoughnut Slice [{1}] key was not found

  • Argument [{0}] is formatted incorrectly format must be

[int SliceIndex | string SliceLabel | ARRAY ( int RingIndex, { int SliceIndex | string SliceLabel} )]

GetRingSliceCount action method

Description

This replay action returns the visible slice count of the supplied ring of the xamDoughnutChart control.

Parameters

The following table explains the method’s parameter followed by code example.

Method parameter Description

iRingIndex

Uniquely identifies the (zero-based) index of the chart’s ring, which can be either inner (0) or outer, depending on the number of rings defined in the application.

Example

Returns the number of visible slices for the inner most ring.

x = …XamDoughnutChart("Identifier").GetRingSliceCount 0
msgbox x

Possible exceptions

The reason of exception returned from this action is that the specified XamDoughnut Ring index [{1}] is out of range.

GetRingSliceLabels action method

Description

This action returns a delimited string of all labels of a given ring of the xamDoughnutChart control.

Parameters

The following table explains the method’s parameter followed by code example.

Method parameter Description

iRingIndex

Uniquely identifies the (zero-based) index of the chart’s ring, which can be either inner or outer.

Example

Returns a delimited string of labels for the visible slices of the inner-most ring.

x = …XamDoughnutChart("Identifier").GetRingSliceLabels 0
msgbox x

Possible exceptions

The reason of exception returned from this action is that the specified XamDoughnut Ring index [{1}] is out of range.

Related Content

Topics

The following topics provide additional information related to this topic.

Topic Purpose

This topic provides information about the xamDoughnutChart control’s testable user actions and elements.

This topic provides information about the xamDoughnutChart control’s testable user recordable methods.

This topic provides reference information about the xamDoughnutChart control’s test object properties.