Go to: Return value. Related commands. Flags. Examples.

Synopsis

keyframeStats [flags] controlName

All of the group commands position their individual controls in columns starting at column 1. The layout of each control (ie. column) can be customized using the -cw/columnWidth, -co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags. By default, columns are left aligned with no offset and are 100 pixels wide. Only one column in any group can be adjustable. This command creates/edits/queries a keyframe stats control.

Return value

string The name of the stats control.

Related commands

copyKey, cutKey, pasteKey, snapKey, keyframe, keyframeOutliner, scaleKey, setInfinity, keyTangent, findKeyframe

Flags

adjustableColumn, adjustableColumn2, adjustableColumn3, adjustableColumn4, adjustableColumn5, adjustableColumn6, animEditor, annotation, backgroundColor, columnAlign, columnAlign2, columnAlign3, columnAlign4, columnAlign5, columnAlign6, columnAttach, columnAttach2, columnAttach3, columnAttach4, columnAttach5, columnAttach6, columnOffset2, columnOffset3, columnOffset4, columnOffset5, columnOffset6, columnWidth, columnWidth1, columnWidth2, columnWidth3, columnWidth4, columnWidth5, columnWidth6, defineTemplate, docTag, dragCallback, dropCallback, edit, enable, exists, height, isObscured, manage, numberOfPopupMenus, parent, popupMenuArray, precision, preventOverride, query, rowAttach, timeAnnotation, useTemplate, valueAnnotation, visible, width

Long name (short name)[argument types]Properties
-query (-q) query
Puts the command in query mode so that it will return the value of the specified flag.
-edit (-e) edit
Puts the command in edit mode so that it will change the values of the specified flags
-exists (-ex) create
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
-defineTemplate (-dt) stringcreate
Puts a command in a mode where any other flags and args are parsed and added to the command template specified in the argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set as the current template.
-useTemplate (-ut) stringcreate
Will force the command to use a command template other than the current one.
-parent (-p) stringcreate
The parent layout for this control.
-enable (-en) booleanquerycreateedit
The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and the control will appear dimmed or greyed-out indicating it is disabled.
-width (-w) intquerycreateedit
The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
-height (-h) intquerycreateedit
The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
-visible (-vis) booleanquerycreateedit
The visible state of the control. A control is created visible by default. Note that a control's actual appearance is also dependent on the visible state of its parent layout(s).
-isObscured (-io) query
Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control's window is invisible or iconified.
-manage (-m) booleanquerycreateedit
Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All controls are created managed by default.
-numberOfPopupMenus (-npm) query
Return the number of popup menus attached to this control.
-popupMenuArray (-pma) query
Return the names of all the popup menus attached to this control.
-preventOverride (-po) booleanquerycreateedit
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
-annotation (-ann) stringquerycreateedit
Annotate the control with an extra string value.
-backgroundColor (-bgc) float float floatcreateedit
The background color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0. (Windows only flag)
-docTag (-dt) querycreateedit
Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material
-dragCallback (-dgc) stringcreateedit
Adds a callback that is called when the middle mouse button is pressed. The callback is of the form:

global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods)

The proc returns a string array that is transferred to the drop site. By convention the first string in the array describes the user settable message type. Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + SHIFT.

-dropCallback (-dpc) stringcreateedit
Adds a callback that is called when a drag and drop operation is released above the drop site. The callback is of the form:

global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int $y, int $type)

The proc receives a string array that is transferred from the drag source. The first string in the msgs array describes the user defined message type. Controls that are application defined drop sites may ignore the callback. $type can have values of 1 == Move, 2 == Copy, 3 == Link.

-columnWidth (-cw) int intcreateedit
Arguments are : column number, column width. Sets the width of the specified column where the first parameter specifies the column (1 based index) and the second parameter specifies the width.
-columnWidth1 (-cw1) intcreateedit
Sets the width of the first column. Ignored if there is not exactly one column.
-columnWidth2 (-cw2) int intcreateedit
Sets the column widths of both columns. Ignored if there is not exactly two columns.
-columnWidth3 (-cw3) int int intcreateedit
Sets the column widths for all 3 columns. Ignored if there is not exactly 3 columns.
-columnWidth4 (-cw4) int int int intcreateedit
Sets the column widths for all 4 columns. Ignored if there is not exactly 4 columns.
-columnWidth5 (-cw5) int int int int intcreateedit
Sets the column widths for all 5 columns. Ignored if there is not exactly 5 columns.
-columnWidth6 (-cw6) int int int int int intcreateedit
Sets the column widths for all 6 columns. Ignored if there is not exactly 6 columns.
-columnAttach (-cat) int string intcreateedit
Arguments are : column number, attachment type, and offset. Possible attachments are: left | right | both. Specifies column attachment types and offets.
-columnAttach2 (-ct2) string stringcreateedit
Sets the attachment type of both columns. Ignored if there is not exactly two columns. Valid values are "left", "right", and "both".
-columnAttach3 (-ct3) string string stringcreateedit
Sets the attachment type for all 3 columns. Ignored if there is not exactly 3 columns. Valid values are "left", "right", and "both".
-columnAttach4 (-ct4) string string string stringcreateedit
Sets the attachment type for all 4 columns. Ignored if there is not exactly 4 columns. Valid values are "left", "right", and "both".
-columnAttach5 (-ct5) string string string string stringcreateedit
Sets the attachment type for all 5 columns. Ignored if there is not exactly 5 columns. Valid values are "left", "right", and "both".
-columnAttach6 (-ct6) string string string string string stringcreateedit
Sets the attachment type for all 6 columns. Ignored if there is not exactly 6 columns. Valid values are "left", "right", and "both".
-columnOffset2 (-co2) int intcreateedit
This flag is used in conjunction with the -columnAttach2 flag. If that flag is not used then this flag will be ignored. It sets the offset for the two columns. The offsets applied are based on the attachments specified with the -columnAttach2 flag. Ignored if there is not exactly two columns.
-columnOffset3 (-co3) int int intcreateedit
This flag is used in conjunction with the -columnAttach3 flag. If that flag is not used then this flag will be ignored. It sets the offset for the three columns. The offsets applied are based on the attachments specified with the -columnAttach3 flag. Ignored if there is not exactly three columns.
-columnOffset4 (-co4) int int int intcreateedit
This flag is used in conjunction with the -columnAttach4 flag. If that flag is not used then this flag will be ignored. It sets the offset for the four columns. The offsets applied are based on the attachments specified with the -columnAttach4 flag. Ignored if there is not exactly four columns.
-columnOffset5 (-co5) int int int int intcreateedit
This flag is used in conjunction with the -columnAttach5 flag. If that flag is not used then this flag will be ignored. It sets the offset for the five columns. The offsets applied are based on the attachments specified with the -columnAttach5 flag. Ignored if there is not exactly five columns.
-columnOffset6 (-co6) int int int int int intcreateedit
This flag is used in conjunction with the -columnAttach6 flag. If that flag is not used then this flag will be ignored. It sets the offset for the six columns. The offsets applied are based on the attachments specified with the -columnAttach6 flag. Ignored if there is not exactly six columns.
-rowAttach (-rat) string intcreateedit
Arguments are : attachment type, offset. Possible attachments are: top | bottom | both. Specifies attachment types and offsets for the entire row.
-columnAlign (-cal) int stringcreateedit
Arguments are : column number, alignment type. Possible alignments are: left | right | center. Specifies alignment type for the specified column.
-columnAlign2 (-cl2) string stringcreateedit
Sets the text alignment of both columns. Ignored if there is not exactly two columns. Valid values are "left", "right", and "center".
-columnAlign3 (-cl3) string string stringcreateedit
Sets the text alignment for all 3 columns. Ignored if there is not exactly 3 columns. Valid values are "left", "right", and "center".
-columnAlign4 (-cl4) string string string stringcreateedit
Sets the text alignment for all 4 columns. Ignored if there is not exactly 4 columns. Valid values are "left", "right", and "center".
-columnAlign5 (-cl5) string string string string stringcreateedit
Sets the text alignment for all 5 columns. Ignored if there is not exactly 5 columns. Valid values are "left", "right", and "center".
-columnAlign6 (-cl6) string string string string string stringcreateedit
Sets the text alignment for all 6 columns. Ignored if there is not exactly 6 columns. Valid values are "left", "right", and "center".
-adjustableColumn (-adj) intcreateedit
Specifies which column has an adjustable size that changes with the sizing of the layout. The column value is a 1-based index. You may also specify 0 to turn off the previous adjustable column.
-adjustableColumn2 (-ad2) intcreateedit
Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there is not exactly two columns.
-adjustableColumn3 (-ad3) intcreateedit
Specifies that the column has an adjustable size that changes with the size of the parent layout. Ignored if there is not exactly three columns.
-adjustableColumn4 (-ad4) intcreateedit
Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there is not exactly four columns.
-adjustableColumn5 (-ad5) intcreateedit
Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there is not exactly five columns.
-adjustableColumn6 (-ad6) intcreateedit
Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there is not exactly six columns.
-precision (-pre) intqueryedit
Controls the number of digits to the right of the decimal point that will be displayed for float-valued channels. Default is 3. Queried, returns an int.
-animEditor (-ae) stringqueryedit
The name of the animation editor which is associated with the control
-timeAnnotation (-tan) stringquerycreateedit
Annotate the time field with an extra string value.
-valueAnnotation (-van) stringquerycreateedit
Annotate the value field with an extra string value.

Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command

Examples

		window -rtf 0 -width 200 "myWindow";
		formLayout "myForm";
		keyframeStats "myOutliner";
		formLayout -e
			-af myOutliner top 0 -af myOutliner left 0 -af myOutliner bottom 0
			-af myOutliner right 0 myForm;
		showWindow;