Vector class

The Vector class gives you access to define vector cards 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

Vector properties

Name Type Description
cid int Coordinate system ID
exists (read only) logical true if vector exists, false if referred to but not defined.
heading string Vector heading
include integer The Include file number that the vector is in.
label integer Vector number. Also see the vid property which is an alternative name for this.
model (read only) integer The Model number that the vector is in.
nodeh int Node ID for head of vector (for _NODES option)
nodes logical _NODES option
nodet int Node ID for tail of vector (for _NODES option)
vid integer Vector number. Also see the label property which is an alternative name for this.
xh real X coordinate of head of vector
xt real X coordinate of tail of vector
yh real Y coordinate of head of vector
yt real Y coordinate of tail of vector
zh real Z coordinate of head of vector
zt real Z coordinate of tail vector

Detailed Description

The Vector class allows you to create, modify, edit and manipulate vector cards. See the documentation below for more details.

Constructor

new Vector(Model[Model], options[object])

Description

Create a new Vector object.

Arguments

  • Model (Model)

    Model that vector will be created in

  • options (object)

    Options for creating the Vector

    Object has the following properties:

    Name Type Description
    ch (optional) array Array of coordinates of head of vector [xh, yh, zh] (for *DEFINE_VECTOR)
    cid (optional) int Optional coordinate system ID (for *DEFINE_VECTOR)
    ct (optional) array Array of coordinates of tail of vector [xt, yt, zt] (for *DEFINE_VECTOR)
    heading (optional) string Optional title for the vector
    nodeh (optional) integer Node ID for head of vector (for *DEFINE_VECTOR_NODES)
    nodes boolean _NODES option (true for *DEFINE_VECTOR_NODES, false for *DEFINE_VECTOR)
    nodet (optional) integer Node ID for tail of vector (for *DEFINE_VECTOR_NODES)
    vid integer Vector ID.

    Returns

    Vector object

    Return type

    Vector

    Example

    To create a new *DEFINE_VECTOR in model m with label 100 with the tail at (1.5, 2.5, 1.0) and the head at (4.5, 4.0, 3.0) 

    var v = new Vector(m, {nodes: 0, vid: 100, ct: [1.5, 2.5, 1.0], ch: [4.5, 4.0, 3.0]});

    To create a new *DEFINE_VECTOR_NODES in model m with label 200 using node 10 for the tail and node 20 for the head 

    var v = new Vector(m, {nodes: 1, vid: 200, nodet: 10, nodeh: 20});

    new Vector(Model[Model], vid[integer], xt[real], yt[real], zt[real], xh[real], yh[real], zh[real], cid (optional)[int], heading (optional)[string])   [deprecated]

    This function is deprecated in version 21.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

    Description

    Create a new Vector object.

    Arguments

  • Model (Model)

    Model that vector will be created in

  • vid (integer)

    Vector number

  • xt (real)

    X coordinate of tail of vector

  • yt (real)

    Y coordinate of tail of vector

  • zt (real)

    Z coordinate of tail vector

  • xh (real)

    X coordinate of head of vector

  • yh (real)

    Y coordinate of head of vector

  • zh (real)

    Z coordinate of head of vector

  • cid (optional) (int)

    Coordinate system ID

  • heading (optional) (string)

    Title for the vector

    Returns

    Vector object

    Return type

    Vector

    Example

    To create a new vector in model m with label 200 

    var v = new Vector(m, 200, 1.5, 2.5, 1.0, 4.5, 4.0, 3.0);

    new Vector(Model[Model], vid[integer], nodet[integer], nodeh[integer], heading (optional)[string])   [deprecated]

    This function is deprecated in version 21.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

    Description

    Create a new Vector object with _NODES option.

    Arguments

  • Model (Model)

    Model that vector will be created in

  • vid (integer)

    Vector number

  • nodet (integer)

    Node ID for tail of vector

  • nodeh (integer)

    Node ID for head of vector

  • heading (optional) (string)

    Title for the vector

    Returns

    Vector object

    Return type

    Vector

    Example

    To create a new vector in model m with label 200 using nodes 10 for the tail and 20 for the head 

    var v = new Vector(m, 200, 20, 30);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a vector.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the vector

    Returns

    No return value

    Example

    To associate comment c to the vector v: 

    v.AssociateComment(c);

    Blank()

    Description

    Blanks the vector

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank vector v: 

    v.Blank();

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

    Description

    Blanks all of the vectors in the model.

    Arguments

  • Model (Model)

    Model that all vectors 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 vectors in model m: 

    Vector.BlankAll(m);

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

    Description

    Blanks all of the flagged vectors in the model.

    Arguments

  • Model (Model)

    Model that all the flagged vectors will be blanked in

  • flag (Flag)

    Flag set on the vectors 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 vectors in model m flagged with f: 

    Vector.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the vector is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if vector v is blanked: 

    if (v.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 vector v: 

    v.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the vector.

    Arguments

  • flag (Flag)

    Flag to clear on the vector

    Returns

    No return value

    Example

    To clear flag f for vector v: 

    v.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

    Copies the vector. The target include of the copied vector 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

    Vector object

    Return type

    Vector

    Example

    To copy vector v into vector z: 

    var z = v.Copy();

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

    Description

    Starts an interactive editing panel to create a vector

    Arguments

  • Model (Model)

    Model that the vector 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

    Vector object (or null if not made).

    Return type

    Vector

    Example

    To start creating a vector in model m: 

    var v = Vector.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a vector.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the vector

    Returns

    No return value

    Example

    To detach comment c from the vector v: 

    v.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 vector v: 

    v.Edit();

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

    Description

    Adds an error for vector. 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 vector v: 

    v.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first vector in the model.

    Arguments

  • Model (Model)

    Model to get first vector in

    Returns

    Vector object (or null if there are no vectors in the model).

    Return type

    Vector

    Example

    To get the first vector in model m: 

    var v = Vector.First(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model to get first free vector 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

    Vector label.

    Return type

    Number

    Example

    To get the first free vector label in model m: 

    var label = Vector.FirstFreeLabel(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all vectors will be flagged in

  • flag (Flag)

    Flag to set on the vectors

    Returns

    No return value

    Example

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

    Vector.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the vector is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the vector

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if vector v has flag f set on it: 

    if (v.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all vectors are in

  • func (function)

    Function to call for each vector

  • 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 vectors in model m: 

    Vector.ForEach(m, test);
function test(v)
{
// v is Vector object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get vectors from

  • property (optional) (string)

    Name for property to get for all vectors in the model

    Returns

    Array of Vector objects or properties

    Return type

    Array

    Example

    To make an array of Vector objects for all of the vectors in model m: 

    var a = Vector.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a vector.

    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 vector v: 

    var comm_array = v.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get vectors from

  • flag (Flag)

    Flag set on the vectors that you want to retrieve

  • property (optional) (string)

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

    Returns

    Array of Vector objects or properties

    Return type

    Array

    Example

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

    var v = Vector.GetFlagged(m, f);

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

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

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

    Description

    Returns the Vector object for a vector ID.

    Arguments

  • Model (Model)

    Model to find the vector in

  • number (integer)

    number of the vector you want the Vector object for

    Returns

    Vector object (or null if vector does not exist).

    Return type

    Vector

    Example

    To get the Vector object for vector 100 in model m 

    var v = Vector.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

    Checks if a Vector 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 Vector.ViewParameters() method and 'method chaining' (see the examples below).

    Arguments

  • prop (string)

    vector property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if Vector property v.example is a parameter: 

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

    To check if Vector property v.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this vector (*DEFINE_VECTOR). Note that a carriage return is not added. See also Vector.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for vector m: 

    var key = m.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for vector v: 

    var cards = v.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last vector in the model.

    Arguments

  • Model (Model)

    Model to get last vector in

    Returns

    Vector object (or null if there are no vectors in the model).

    Return type

    Vector

    Example

    To get the last vector in model m: 

    var v = Vector.Last(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model to get last free vector 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

    Vector label.

    Return type

    Number

    Example

    To get the last free vector label in model m: 

    var label = Vector.LastFreeLabel(m);

    Next()

    Description

    Returns the next vector in the model.

    Arguments

    No arguments

    Returns

    Vector object (or null if there are no more vectors in the model).

    Return type

    Vector

    Example

    To get the vector in model m after vector v: 

    var v = v.Next();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get next free vector 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

    Vector label.

    Return type

    Number

    Example

    To get the next free vector label in model m: 

    var label = Vector.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 vector.

    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 vectors from that model can be picked. If the argument is a Flag then only vectors that are flagged with limit can be selected. If omitted, or null, any vectors 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

    Vector object (or null if not picked)

    Return type

    Vector

    Example

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

    var v = Vector.Pick('Pick vector from screen', m);

    Previous()

    Description

    Returns the previous vector in the model.

    Arguments

    No arguments

    Returns

    Vector object (or null if there are no more vectors in the model).

    Return type

    Vector

    Example

    To get the vector in model m before vector v: 

    var v = v.Previous();

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

    Description

    Renumbers all of the vectors in the model.

    Arguments

  • Model (Model)

    Model that all vectors will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Vector.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged vectors in the model.

    Arguments

  • Model (Model)

    Model that all the flagged vectors will be renumbered in

  • flag (Flag)

    Flag set on the vectors that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Vector.RenumberFlagged(m, f, 1000000);

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

    Description

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

    Arguments

  • flag (Flag)

    Flag to use when selecting vectors

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

    If the argument is a Model then only vectors from that model can be selected. If the argument is a Flag then only vectors that are flagged with limit can be selected (limit should be different to flag). If omitted, or null, any vectors 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 vectors selected or null if menu cancelled

    Return type

    Number

    Example

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

    Vector.Select(f, 'Select vectors', m);

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

    Vector.Select(f, 'Select vectors', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the vector.

    Arguments

  • flag (Flag)

    Flag to set on the vector

    Returns

    No return value

    Example

    To set flag f for vector v: 

    v.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch vector v: 

    v.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged vectors will be sketched in

  • flag (Flag)

    Flag set on the vectors that you want to sketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the vectors are sketched. If omitted redraw is true. If you want to sketch flagged vectors 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 vectors flagged with flag in model m: 

    Vector.SketchFlagged(m, flag);

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

    Description

    Returns the total number of vectors in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of vectors

    Return type

    Number

    Example

    To get the total number of vectors in model m: 

    var total = Vector.Total(m);

    Unblank()

    Description

    Unblanks the vector

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank vector v: 

    v.Unblank();

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

    Description

    Unblanks all of the vectors in the model.

    Arguments

  • Model (Model)

    Model that all vectors 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 vectors in model m: 

    Vector.UnblankAll(m);

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

    Description

    Unblanks all of the flagged vectors in the model.

    Arguments

  • Model (Model)

    Model that the flagged vectors will be unblanked in

  • flag (Flag)

    Flag set on the vectors 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 vectors in model m flagged with f: 

    Vector.UnblankFlagged(m, f);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the vectors

    Returns

    No return value

    Example

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

    Vector.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the vector.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch vector v: 

    v.Unsketch();

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

    Description

    Unsketches all vectors.

    Arguments

  • Model (Model)

    Model that all vectors will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not after the vectors 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 vectors in model m: 

    Vector.UnsketchAll(m);

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

    Description

    Unsketches all flagged vectors in the model.

    Arguments

  • Model (Model)

    Model that all vectors will be unsketched in

  • flag (Flag)

    Flag set on the vectors that you want to unsketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the vectors 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 vectors flagged with flag in model m: 

    Vector.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

    Vector object.

    Return type

    Vector

    Example

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

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

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

    Description

    Adds a warning for vector. 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 vector v: 

    v.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this vector.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for vector v: 

    var xrefs = v.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for vector v in keyword format 

    var s = v.toString();