pgplotwidget.message

write in the message line

Synopsis
message(message)

Description
This function sends a message to the message line above the plot area. It is intended for messages which instruct the user in driving the application the widget is embedded in. For example, use it to relay what the mouse or keyboard events are expected.

If you send a message that is more than one line long (i.e. if it has embedded newline characters), a button will appear to the right of the message. Pressing it will display the entire message in a popup window. You should try to arrange multi-line messages so that the first line contains a summary, and subsequent lines contain more detailed instructions. This way frequent users won't have to pop up a new window very often.

Clear the line by sending it an empty string.

Arguments

message		message to write
		Allowed:	string

Next: pgplotwidget.settings - Function Up: pgplotwidget - Tool Previous: pgplotwidget.clear - Function Contents Index

	Package	display
	Module	plotter
	Tool	pgplotwidget

pgplotwidget.message - Function