DeleteCategory PowerScript function

Description

Deletes a category and the data values for that category from
the category axis of a graph.

Context

Graph controls in windows and user objects. Does
not apply to graphs within DataWindow objects (because their data
comes directly from the DataWindow).

Syntax

<span>controlname</span>.<span>DeleteCategory</span> ( <span>categoryvalue</span> )

1	<span>controlname</span>.<span>DeleteCategory</span> ( <span>categoryvalue</span> )

Argument	Description
controlname	The graph in which you want to delete a category.
categoryvalue	A value that is the category you want to delete from controlname. The value you specify must be the same datatype as the datatype of the category axis.

Return Values

Integer. Returns 1 if it succeeds and
-1 if an error occurs. If any argument’s value is null, DeleteCategory returns null.

Examples

These statements delete the category whose name is
entered in the SingleLineEdit sle_delete from
the graph gr_product_data:

string CategName

1	string CategName

CategName = sle_delete.Text

1	CategName = sle_delete.Text

gr_product_data.<span>DeleteCategory</span>(CategName)

1	gr_product_data.<span>DeleteCategory</span>(CategName)

August 13, 2023

Was this article helpful?

Connection Information

DeleteCategory – PB Docs 126