Group class

The Group class gives you access to groups in PRIMER. More...

The PRIMER JavaScript API provides many class constants, properties and methods. For Arup to be able to extend and enhance the API in the future any constant, property or method names beginning with a lowercase or uppercase letter are reserved.
If you need to add your own properties or methods to one of the existing classes then to avoid any potential future conflict you should ensure that the name begins with either an underscore (_) or a dollar sign ($) or the name is prefixed with your own unique identifier.
For example if company 'ABC' need to add a property called 'example' then to avoid any potential future conflict use one of:

Class functions

Member functions

Group constants

Name Description
Group.ADD Add contents to group
Group.REMOVE Remove contents from group

Group properties

Name Type Description
exists (read only) logical true if group exists, false if referred to but not defined.
include integer The Include file number that the group is in.
label integer Group number
lock logical Whether Group contents are locked against deletion.
model (read only) integer The Model number that the group is in.
numtypes (read only) integer Number of types in the group.
title string Group title

Detailed Description

The Group class allows you to create, modify, edit and manipulate groups. See the documentation below for more details.

Constructor

new Group(Model[Model], label[integer], title (optional)[string])

Description

Create a new Group object.

Arguments

  • Model (Model)

    Model that Group will be created in

  • label (integer)

    Group number.

  • title (optional) (string)

    Title for the group

    Returns

    Group object

    Return type

    Group

    Example

    To create a new group 99 in model m with title "Example": 

    var g = new Group(m, 99, "Example");

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a group.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the group

    Returns

    No return value

    Example

    To associate comment c to the group g: 

    g.AssociateComment(c);

    Blank()

    Description

    Blanks the group

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank group g: 

    g.Blank();

    BlankAll(Model[Model], redraw (optional)[boolean]) [static]

    Description

    Blanks all of the groups in the model.

    Arguments

  • Model (Model)

    Model that all groups will be blanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To blank all of the groups in model m: 

    Group.BlankAll(m);

    BlankFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

    Description

    Blanks all of the flagged groups in the model.

    Arguments

  • Model (Model)

    Model that all the flagged groups will be blanked in

  • flag (Flag)

    Flag set on the groups that you want to blank

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To blank all of the groups in model m flagged with f: 

    Group.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the group is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if group g is blanked: 

    if (g.Blanked() ) do_something...

    Browse(modal (optional)[boolean])

    Description

    Starts an edit panel in Browse mode.

    Arguments

  • modal (optional) (boolean)

    If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.

    Returns

    no return value

    Example

    To Browse group g: 

    g.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the group.

    Arguments

  • flag (Flag)

    Flag to clear on the group

    Returns

    No return value

    Example

    To clear flag f for group g: 

    g.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

    Copies the group. The target include of the copied group can be set using Options.copy_target_include.

    Arguments

  • range (optional) (boolean)

    If you want to keep the copied item in the range specified for the current include. Default value is false. To set current include, use Include.MakeCurrentLayer().

    Returns

    Group object

    Return type

    Group

    Example

    To copy group g into group z: 

    var z = g.Copy();

    Create(Model[Model], modal (optional)[boolean]) [static]

    Description

    Starts an interactive editing panel to create a group

    Arguments

  • Model (Model)

    Model that the group will be created in.

  • modal (optional) (boolean)

    If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.

    Returns

    Group object (or null if not made).

    Return type

    Group

    Example

    To start creating a group in model m: 

    var g = Group.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a group.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the group

    Returns

    No return value

    Example

    To detach comment c from the group g: 

    g.DetachComment(c);

    Edit(modal (optional)[boolean])

    Description

    Starts an interactive editing panel.

    Arguments

  • modal (optional) (boolean)

    If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.

    Returns

    no return value

    Example

    To Edit group g: 

    g.Edit();

    Error(message[string], details (optional)[string])

    Description

    Adds an error for group. For more details on checking see the Check class.

    Arguments

  • message (string)

    The error message to give

  • details (optional) (string)

    An optional detailed error message

    Returns

    No return value

    Example

    To add an error message "My custom error" for group g: 

    g.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first group in the model.

    Arguments

  • Model (Model)

    Model to get first group in

    Returns

    Group object (or null if there are no groups in the model).

    Return type

    Group

    Example

    To get the first group in model m: 

    var g = Group.First(m);

    FirstFreeLabel(Model[Model], layer (optional)[Include number]) [static]

    Description

    Returns the first free group label in the model. Also see Group.LastFreeLabel(), Group.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

    Model to get first free group label in

  • layer (optional) (Include number)

    Include file (0 for the main file) to search for labels in (Equivalent to First free in layer in editing panels). If omitted the whole model will be used (Equivalent to First free in editing panels).

    Returns

    Group label.

    Return type

    Number

    Example

    To get the first free group label in model m: 

    var label = Group.FirstFreeLabel(m);

    FlagAll(Model[Model], flag[Flag]) [static]

    Description

    Flags all of the groups in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all groups will be flagged in

  • flag (Flag)

    Flag to set on the groups

    Returns

    No return value

    Example

    To flag all of the groups with flag f in model m: 

    Group.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the group is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the group

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if group g has flag f set on it: 

    if (g.Flagged(f) ) do_something...

    ForEach(Model[Model], func[function], extra (optional)[any]) [static]

    Description

    Calls a function for each group in the model.
    Note that ForEach has been designed to make looping over groups as fast as possible and so has some limitations.
    Firstly, a single temporary Group object is created and on each function call it is updated with the current group data. This means that you should not try to store the Group object for later use (e.g. in an array) as it is temporary.
    Secondly, you cannot create new groups inside a ForEach loop.

    Arguments

  • Model (Model)

    Model that all groups are in

  • func (function)

    Function to call for each group

  • extra (optional) (any)

    An optional extra object/array/string etc that will appended to arguments when calling the function

    Returns

    No return value

    Example

    To call function test for all of the groups in model m: 

    Group.ForEach(m, test);
function test(g)
{
// g is Group object
}

    To call function test for all of the groups in model m with optional object: 

    var data = { x:0, y:0 };
Group.ForEach(m, test, data);
function test(g, extra)
{
// g is Group object
// extra is data
}

    GetAll(Model[Model], property (optional)[string]) [static]

    Description

    Returns an array of Group objects or properties for all of the groups in a model in PRIMER. If the optional property argument is not given then an array of Group objects is returned. If the property argument is given, that property value for each group is returned in the array instead of a Group object

    Arguments

  • Model (Model)

    Model to get groups from

  • property (optional) (string)

    Name for property to get for all groups in the model

    Returns

    Array of Group objects or properties

    Return type

    Array

    Example

    To make an array of Group objects for all of the groups in model m: 

    var a = Group.GetAll(m);

    To return an array containing the value of property 'foo' (for example 'x' for a node) for each group in model m: 

    var a = Group.GetAll(m, 'foo');

    GetComments()

    Description

    Extracts the comments associated to a group.

    Arguments

    No arguments

    Returns

    Array of Comment objects (or null if there are no comments associated to the node).

    Return type

    Array

    Example

    To get the array of comments associated to the group g: 

    var comm_array = g.GetComments();

    GetDataAll(type[string], index[integer])

    Description

    Returns 'all' data for a given row number and type in the group.

    Arguments

  • type (string)

    The type of the item

  • index (integer)

    Index of 'all' row you want the data for. Note that indices start at 0, not 1.
    0 <= index < Group.GetTotalAll()

    Returns

    An array containing data [Group.ADD or Group.REMOVE, BOX (if defined)].

    Return type

    Array

    Example

    To get the data for the 3rd SHELL 'all' row in group g: 

    var data = g.GetDataAll("SHELL", 2);

    GetDataList(type[string], index[integer])

    Description

    Returns 'list' data for a given row number and type in the group.

    Arguments

  • type (string)

    The type of the item

  • index (integer)

    Index of 'list' row you want the data for. Note that indices start at 0, not 1.
    0 <= index < Group.GetTotalList()

    Returns

    An array containing data [Group.ADD or Group.REMOVE, ITEM1 (if defined), ITEM2 (if defined), ITEM3 (if defined), ITEM4 (if defined), ITEM5 (if defined), BOX (if defined)].

    Return type

    Array

    Example

    To get the data for the 3rd SHELL 'list' row in group g: 

    var data = g.GetDataList("SHELL", 2);

    GetDataRange(type[string], index[integer])

    Description

    Returns 'range' data for a given row number and type in the group.

    Arguments

  • type (string)

    The type of the item

  • index (integer)

    Index of 'range' row you want the data for. Note that indices start at 0, not 1.
    0 <= index < Group.GetTotalRange()

    Returns

    An array containing data [Group.ADD or Group.REMOVE, START, END, BOX (if defined)].

    Return type

    Array

    Example

    To get the data for the 3rd SHELL 'range' row in group g: 

    var data = g.GetDataRange("SHELL", 2);

    GetFlagged(Model[Model], flag[Flag], property (optional)[string]) [static]

    Description

    Returns an array of Group objects for all of the flagged groups in a model in PRIMER If the optional property argument is not given then an array of Group objects is returned. If the property argument is given, then that property value for each group is returned in the array instead of a Group object

    Arguments

  • Model (Model)

    Model to get groups from

  • flag (Flag)

    Flag set on the groups that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged groups in the model

    Returns

    Array of Group objects or properties

    Return type

    Array

    Example

    To make an array of Group objects for all of the groups in model m flagged with f: 

    var g = Group.GetFlagged(m, f);

    To return an array containing the value of property 'foo' (for example 'x' for a node) for all of the groups in model m flagged with f: 

    var a = Group.GetFlagged(m, f, 'foo');

    GetFromID(Model[Model], number[integer]) [static]

    Description

    Returns the Group object for a group ID.

    Arguments

  • Model (Model)

    Model to find the group in

  • number (integer)

    number of the group you want the Group object for

    Returns

    Group object (or null if group does not exist).

    Return type

    Group

    Example

    To get the Group object for group 100 in model m 

    var g = Group.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

    Checks if a Group property is a parameter or not. Note that object properties that are parameters are normally returned as the integer or float parameter values as that is virtually always what the user would want. For this function to work the JavaScript interpreter must use the parameter name instead of the value. This can be done by setting the Options.property_parameter_names option to true before calling the function and then resetting it to false afterwards.. This behaviour can also temporarily be switched by using the Group.ViewParameters() method and 'method chaining' (see the examples below).

    Arguments

  • prop (string)

    group property to get parameter for

    Returns

    Parameter object if property is a parameter, null if not.

    Return type

    Parameter

    Example

    To check if Group property g.example is a parameter: 

    Options.property_parameter_names = true;
if (g.GetParameter(g.example) ) do_something...
Options.property_parameter_names = false;

    To check if Group property g.example is a parameter by using the GetParameter method: 

    if (g.ViewParameters().GetParameter(g.example) ) do_something...

    GetTotalAll(type[string])

    Description

    Returns the total number of 'all' rows for a type in a group

    Arguments

  • type (string)

    The type of the item

    Returns

    The number of 'all' rows defined

    Return type

    Number

    Example

    To get the total number of shell 'all' rows in group g: 

    var nrow = g.GetTotalAll("SHELL");

    GetTotalList(type[string])

    Description

    Returns the total number of 'list' rows for a type in a group

    Arguments

  • type (string)

    The type of the item

    Returns

    The number of 'list' rows defined

    Return type

    Number

    Example

    To get the total number of shell 'list' rows in group g: 

    var nrow = g.GetTotalList("SHELL");

    GetTotalRange(type[string])

    Description

    Returns the total number of 'range' rows for a type in a group

    Arguments

  • type (string)

    The type of the item

    Returns

    The number of 'range' rows defined

    Return type

    Number

    Example

    To get the total number of shell 'range' rows in group g: 

    var nrow = g.GetTotalRange("SHELL");

    GetTotals(type[string])

    Description

    Returns the total number of 'all', 'list' and 'range' rows for a type in a group

    Arguments

  • type (string)

    The type of the item

    Returns

    Array containing number of 'all', 'list' and 'range' rows defined or null if type not in group.

    Return type

    Array

    Example

    To get the total number of shell 'all', 'list' and 'range' rows in group g: 

    var totals = g.GetTotals("SHELL");
var nall   = totals[0];
var nlist  = totals[1];
var nrange = totals[2];

    GetType(row[integer])

    Description

    Returns the type for an entry in a group

    Arguments

  • row (integer)

    The entry in the group types that you want the type for. Note that entries start at 0, not 1

    Returns

    The type of the item (string)

    Return type

    String

    Example

    To list the types that are present in group g: 

    for (var t=0; t<g.numtypes; t++)
{
    var type = g.GetType(t);
    Message(type);
}

    Keyword()

    Description

    Returns the keyword for this group. Note that a carriage return is not added. See also Group.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for goup g: 

    var key = g.Keyword();

    KeywordCards()

    Description

    Returns the keyword cards for the Group. Note that a carriage return is not added. See also Group.Keyword()

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for Group g: 

    var cards = g.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last group in the model.

    Arguments

  • Model (Model)

    Model to get last group in

    Returns

    Group object (or null if there are no groups in the model).

    Return type

    Group

    Example

    To get the last group in model m: 

    var g = Group.Last(m);

    LastFreeLabel(Model[Model], layer (optional)[Include number]) [static]

    Description

    Returns the last free group label in the model. Also see Group.FirstFreeLabel(), Group.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

    Model to get last free group label in

  • layer (optional) (Include number)

    Include file (0 for the main file) to search for labels in (Equivalent to Highest free in layer in editing panels). If omitted the whole model will be used.

    Returns

    Group label.

    Return type

    Number

    Example

    To get the last free group label in model m: 

    var label = Group.LastFreeLabel(m);

    Next()

    Description

    Returns the next group in the model.

    Arguments

    No arguments

    Returns

    Group object (or null if there are no more groups in the model).

    Return type

    Group

    Example

    To get the group in model m after group g: 

    var g = g.Next();

    NextFreeLabel(Model[Model], layer (optional)[Include number]) [static]

    Description

    Returns the next free (highest+1) group label in the model. Also see Group.FirstFreeLabel(), Group.LastFreeLabel() and Model.NextFreeItemLabel()

    Arguments

  • Model (Model)

    Model to get next free group label in

  • layer (optional) (Include number)

    Include file (0 for the main file) to search for labels in (Equivalent to Highest+1 in layer in editing panels). If omitted the whole model will be used (Equivalent to Highest+1 in editing panels).

    Returns

    Group label.

    Return type

    Number

    Example

    To get the next free group label in model m: 

    var label = Group.NextFreeLabel(m);

    Pick(prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean], button text (optional)[string]) [static]

    Description

    Allows the user to pick a group.

    Arguments

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

    If the argument is a Model then only groups from that model can be picked. If the argument is a Flag then only groups that are flagged with limit can be selected. If omitted, or null, any groups from any model can be selected. from any model.

  • modal (optional) (boolean)

    If picking is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the pick will be modal.

  • button text (optional) (string)

    By default the window with the prompt will have a button labelled 'Cancel' which if pressed will cancel the pick and return null. If you want to change the text on the button use this argument. If omitted 'Cancel' will be used.

    Returns

    Group object (or null if not picked)

    Return type

    Group

    Example

    To pick a group from model m giving the prompt 'Pick group from screen': 

    var g = Group.Pick('Pick group from screen', m);

    Previous()

    Description

    Returns the previous group in the model.

    Arguments

    No arguments

    Returns

    Group object (or null if there are no more groups in the model).

    Return type

    Group

    Example

    To get the group in model m before group g: 

    var g = g.Previous();

    RemoveDataAll(type[string], index[integer])

    Description

    Removes 'all' data for a given row number and type in the group.

    Arguments

  • type (string)

    The type of the item

  • index (integer)

    Index of 'all' row you want to Remove. Note that indices start at 0, not 1.
    0 <= index < Group.GetTotalAll()

    Returns

    No return value

    Example

    To remove the data for the 3rd SHELL 'all' row in group g: 

    g.RemoveDataAll("SHELL", 2);

    RemoveDataList(type[string], index[integer])

    Description

    Removes 'list' data for a given row number and type in the group.

    Arguments

  • type (string)

    The type of the item

  • index (integer)

    Index of 'list' row you want to Remove. Note that indices start at 0, not 1.
    0 <= index < Group.GetTotalList()

    Returns

    No return value

    Example

    To remove the data for the 3rd SHELL 'list' row in group g: 

    g.RemoveDataList("SHELL", 2);

    RemoveDataRange(type[string], index[integer])

    Description

    Removes 'range' data for a given row number and type in the group.

    Arguments

  • type (string)

    The type of the item

  • index (integer)

    Index of 'range' row you want to Remove. Note that indices start at 0, not 1.
    0 <= index < Group.GetTotalRange()

    Returns

    No return value

    Example

    To remove the data for the 3rd SHELL 'range' row in group g: 

    g.RemoveDataRange("SHELL", 2);

    RenumberAll(Model[Model], start[integer]) [static]

    Description

    Renumbers all of the groups in the model.

    Arguments

  • Model (Model)

    Model that all groups will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the groups in model m, from 1000000: 

    Group.RenumberAll(m, 1000000);

    RenumberFlagged(Model[Model], flag[Flag], start[integer]) [static]

    Description

    Renumbers all of the flagged groups in the model.

    Arguments

  • Model (Model)

    Model that all the flagged groups will be renumbered in

  • flag (Flag)

    Flag set on the groups that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the groups in model m flagged with f, from 1000000: 

    Group.RenumberFlagged(m, f, 1000000);

    Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean]) [static]

    Description

    Allows the user to select groups using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting groups

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

    If the argument is a Model then only groups from that model can be selected. If the argument is a Flag then only groups that are flagged with limit can be selected (limit should be different to flag). If omitted, or null, any groups can be selected. from any model.

  • modal (optional) (boolean)

    If selection is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the selection will be modal.

    Returns

    Number of groups selected or null if menu cancelled

    Return type

    Number

    Example

    To select groups from model m, flagging those selected with flag f, giving the prompt 'Select groups': 

    Group.Select(f, 'Select groups', m);

    To select groups, flagging those selected with flag f but limiting selection to groups flagged with flag l, giving the prompt 'Select groups': 

    Group.Select(f, 'Select groups', l);

    SetDataAll(type[string], index[integer], data[Array of data])

    Description

    Sets 'all' data for a given row number and type in the group.

    Arguments

  • type (string)

    The type of the item

  • index (integer)

    Index of 'all' row you want the data for. Note that indices start at 0, not 1.
    0 <= index <= Group.GetTotalAll()

  • data (Array of data)

    An array containing data [Group.ADD or Group.REMOVE, BOX (if defined)].

    Returns

    No return value

    Example

    To set the data for the 3rd SHELL 'all' row in group g to 'add box 10': 

    var data = [Group.ADD, 10];
g.SetDataAll("SHELL", 2, data);

    SetDataList(type[string], index[integer], data[Array of data])

    Description

    Sets 'list' data for a given row number and type in the group.

    Arguments

  • type (string)

    The type of the item

  • index (integer)

    Index of 'list' row you want the data for. Note that indices start at 0, not 1.
    0 <= index <= Group.GetTotalList()

  • data (Array of data)

    An array containing data [Group.ADD or Group.REMOVE, ITEM1 (if defined), ITEM2 (if defined), ITEM3 (if defined), ITEM4 (if defined), ITEM5 (if defined), BOX (if defined)].

    Returns

    No return value

    Example

    To set the data for the 3rd SHELL 'list' row in group g to 'add 1 2 box 10': 

    var data = [Group.ADD, 1, 2, 0, 0, 0, 10];
g.SetDataList("SHELL", 2, data);

    SetDataRange(type[string], index[integer], data[Array of data])

    Description

    Sets 'range' data for a given row number and type in the group.

    Arguments

  • type (string)

    The type of the item

  • index (integer)

    Index of 'all' row you want the data for. Note that indices start at 0, not 1.
    0 <= index <= Group.GetTotalRange()

  • data (Array of data)

    An array containing data [Group.ADD or Group.REMOVE, START, END, BOX (if defined)].

    Returns

    No return value

    Example

    To set the data for the 3rd SHELL 'range' row in group g to 'add 100 200 box 10': 

    var data = [Group.ADD, 100, 200, 10];
g.SetDataRange("SHELL", 2, data);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the group.

    Arguments

  • flag (Flag)

    Flag to set on the group

    Returns

    No return value

    Example

    To set flag f for group g: 

    g.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

    Sketches the group. The group will be sketched until you either call Group.Unsketch(), Group.UnsketchAll(), Model.UnsketchAll(), or delete the model

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the group is sketched. If omitted redraw is true. If you want to sketch several groups and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To sketch group g: 

    g.Sketch();

    SketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

    Description

    Sketches all of the flagged groups in the model. The groups will be sketched until you either call Group.Unsketch(), Group.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

    Arguments

  • Model (Model)

    Model that all the flagged groups will be sketched in

  • flag (Flag)

    Flag set on the groups that you want to sketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the groups are sketched. If omitted redraw is true. If you want to sketch flagged groups several times and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To sketch all groups flagged with flag in model m: 

    Group.SketchFlagged(m, flag);

    Total(Model[Model], exists (optional)[boolean]) [static]

    Description

    Returns the total number of groups in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

    true if only existing groups should be counted. If false or omitted referenced but undefined groups will also be included in the total.

    Returns

    number of groups

    Return type

    Number

    Example

    To get the total number of groups in model m: 

    var total = Group.Total(m);

    Unblank()

    Description

    Unblanks the group

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank group g: 

    g.Unblank();

    UnblankAll(Model[Model], redraw (optional)[boolean]) [static]

    Description

    Unblanks all of the groups in the model.

    Arguments

  • Model (Model)

    Model that all groups will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To unblank all of the groups in model m: 

    Group.UnblankAll(m);

    UnblankFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

    Description

    Unblanks all of the flagged groups in the model.

    Arguments

  • Model (Model)

    Model that the flagged groups will be unblanked in

  • flag (Flag)

    Flag set on the groups that you want to unblank

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To unblank all of the groups in model m flagged with f: 

    Group.UnblankFlagged(m, f);

    UnflagAll(Model[Model], flag[Flag]) [static]

    Description

    Unsets a defined flag on all of the groups in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all groups will be unset in

  • flag (Flag)

    Flag to unset on the groups

    Returns

    No return value

    Example

    To unset the flag f on all the groups in model m: 

    Group.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the group.

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the group is unsketched. If omitted redraw is true. If you want to unsketch several groups and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To unsketch group g: 

    g.Unsketch();

    UnsketchAll(Model[Model], redraw (optional)[boolean]) [static]

    Description

    Unsketches all groups.

    Arguments

  • Model (Model)

    Model that all groups will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not after the groups are unsketched. If omitted redraw is true. If you want to unsketch several things and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To unsketch all groups in model m: 

    Group.UnsketchAll(m);

    UnsketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

    Description

    Unsketches all flagged groups in the model.

    Arguments

  • Model (Model)

    Model that all groups will be unsketched in

  • flag (Flag)

    Flag set on the groups that you want to unsketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the groups are unsketched. If omitted redraw is true. If you want to unsketch several things and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To unsketch all groups flagged with flag in model m: 

    Group.UnsketchAll(m, flag);

    ViewParameters()

    Description

    Object properties that are parameters are normally returned as the integer or float parameter values as that is virtually always what the user would want. This function temporarily changes the behaviour so that if a property is a parameter the parameter name is returned instead. This can be used with 'method chaining' (see the example below) to make sure a property argument is correct.

    Arguments

    No arguments

    Returns

    Group object.

    Return type

    Group

    Example

    To check if Group property g.example is a parameter by using the Group.GetParameter() method: 

    if (g.ViewParameters().GetParameter(g.example) ) do_something...

    Warning(message[string], details (optional)[string])

    Description

    Adds a warning for group. For more details on checking see the Check class.

    Arguments

  • message (string)

    The warning message to give

  • details (optional) (string)

    An optional detailed warning message

    Returns

    No return value

    Example

    To add a warning message "My custom warning" for group g: 

    g.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this group.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for group g: 

    var xrefs = g.Xrefs();

    toString()

    Description

    Creates a string containing the Group data in keyword format. Note that this contains the keyword header and the keyword cards. See also Group.Keyword() and Group.KeywordCards().

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for Group g in keyword format 

    var s = g.toString();