[ Main table Of Contents | Tklib Table Of Contents | Tklib Index ]

pieBoxLabeler(n) 6.6 "pieBoxLabeler class"

NAME

pieBoxLabeler - tkpiechart pie box style labeler class

    TABLE OF CONTENTS
    SYNOPSIS
    DESCRIPTION
    OPTIONS
    TAGS
    SEE ALSO
    KEYWORDS
    COPYRIGHT

SYNOPSIS

stooop::new pieBoxLabeler canvas ?options?

switched::configure pieBoxLabelerObject ?options?

switched::cget pieBoxLabelerObject option

DESCRIPTION

The pie box style labeler object is used as a slice label placer for a pie object and is passed to the pie constructor via its -labeler option (see the pie class manual).

The labels are arranged in 2 columns below the pie graphics. Each label text is placed to the right of a rectangle, the background color of which matches its corresponding slice. The slice share value is placed to the right of the label text, separated by a semicolon. Each label is actually a canvasLabel object (see the canvasLabel class manual for further information).

There is no need to delete a pieBoxLabeler object as it is automatically handled by the pie class.

stooop::new pieBoxLabeler canvas ?options?: Creates a pieBoxLabeler object in the specified Tk canvas. The pieBoxLabeler object identifier is returned (referred to as pieBoxLabelerObject in this document).
switched::configure pieBoxLabelerObject ?options?: Configures a pieBoxLabeler object or returns all the options with their current values if no options are passed as parameters.
switched::cget pieBoxLabelerObject option: Returns an option value for the specified pieBoxLabeler object.

OPTIONS

-font value: Specifies a font for the slice labels. If not specified, the default font is system dependent.
-justify value: Specifies how to justify labels within their own column. Must be one of left, center or right. Defaults to left. For example, if justification is right, all column labels right edges are aligned.
-offset value: Specifies the distance between the pie graphics and the closest slice label. This value may be specified in any of the forms described in the canvas COORDINATES manual section.

KEYWORDS

canvas , labeler , pie , slice

pieBoxLabeler(n) 6.6 "pieBoxLabeler class"

Copyright © 2005 for compilation: ActiveState