8.1.2 Column

It is recommended that you switch to the originpro package. PyOrigin is primarily for users who need to work with Origin version prior to 2021.

Name

Column

Hierarchy


Property

Name Brief Example
CategMapCategories Read only property. Get the categorical map of the column. Examples
CategMapSort Read only property. Return the sort order of the categories. Examples
CategMapType Get/Set the categorical map type. Examples
Comments Get/Set the comments in a column label. Examples
Format Get/Set the column format. Examples
LowerBound Get/Set the begining row display index Examples
SubFormat Get/Set the SubFormat used by a column. Examples
Type Get/Set the type designator of a column Examples
Units Get/Set the units in a column label Examples
UpperBound Get/Set the ending row display index Examples
X0 Get/Set Column Additional information: EvenX Initial Value Examples
X1 Get/Set Column Additional information EvenX Increment Examples

Members

Name Brief Example
GetCategMapCategories Get the categorical map of the column. Examples
GetCategMapSort Get the sort order of the categories. Examples
GetCategMapType Get the categorical map type. Examples
GetComments Get the comments in a column label. Examples
GetData Get the column data Examples
GetFormat Get the column format. Examples
GetLowerBound Get the begining row index for this column. Index values are 0 based. Examples
GetParameter Get one parameter value from column label. Examples
GetParent Get the Parent worksheet Examples
GetStringArray Copy the contents of a Text Dataset into a StringArray. Examples
GetSubFormat Get the SubFormat used by a column. Examples
GetType Get the type designator of a column (X, Y, Z, YErr, XErr, L or disregard). Examples
GetUnits Get the units in a column label. Examples
GetUpperBound Get the row index of the last data in this column. Index values are 0 based. Examples
GetUserDefLabel Get the user defined label Examples
GetX0 Get Column Additional information: EvenX Initial Value Examples
GetX1 Get Column Additional information EvenX Increment Examples
PutStringArray Put (copy) the contents of a StringArray to a Column Examples
SetCategMapSortCategories Set the category list and sort order. Examples
SetCategMapType Set the categorical map type. Examples
SetComments Set the comments in a column label. Examples
SetData Put an array of values to a column object Examples
SetFormat Set the column format Examples
SetLowerBound Set the begining row display index Examples
SetParameter Set one parameter in a column label Examples
SetSubFormat Set the SubFormat used by a column. Examples
SetType Set the type designator of a column (X, Y, Z, YErr, XErr, L or disregard) Examples
SetUnits Set the units in a column label Examples
SetUpperBound Set the ending row display indices for this column. Index values are 0 based offsets so use SetUpperBound(-1) to display no rows Examples
SetUserDefLabel Set the user defined label Examples
SetX0 Set Column Additional information EvenX Initial Value Examples
SetX1 Set Column Additional information EvenX Increment Examples


DataObject Members

Name Brief Example
ExecuteFormula Trigger the execution of Column/MatrixObject formula Examples
GetDataFormat Get DataFormat property of one DataObject Examples
GetDigitMode Gets the display mode used for numbers in a column Examples
GetDigits Get the digit value for the numeric display mode. Examples
GetDisplayFormat Get the display format of the DataObject Examples
GetFormula Get the formula of the DataObject Examples
SetDataFormat Set DataFormat property of one DataObject Examples
SetDigitMode Set the display mode used for numbers in a column Examples
SetDigits Set the digit value for the numeric display mode Examples
SetDisplayFormat Gets the display format of the DataObject Examples
SetFormula Set the LabTalk formula and optional Before Formula Script for Column and MatrixObject Examples


DataObjectBase Members

Name Brief Example
GetDatasetName Get the name of the dataset which the DataObjectBase object is associated with. Examples


OriginObject Members

Name Brief Example
Destroy Destroy the Origin object Examples
DoMethod Execute object LabTalk methods Examples
GetBinaryStorage Get a binary storage as a tree
GetComments Retrieve the comments from an object that supports Comments Examples
GetIndex Get the index of an object in a Collection Examples
GetLongName Get the long name of an object Examples
GetName Get the short name of an object Examples
GetNumProp Get object property via LabTalk property name Examples
GetShow Get the show status of an object Examples
GetStorageNames Get names of storage class objects
GetStrProp Get object property via LabTalk property name Examples
GetTheme Get the theme as treenode Examples
LT_execute Execute the Labtalk script code. Examples
SetComments Sets the comments with a text string to an object that supports Comments Examples
SetIndex Set the index of an object in a Collection Examples
SetLongName Set the long name of an object Examples
SetName Set the short name of an object Examples
SetNumProp Set object property via LabTalk property name Examples
SetShow Set the show status of an object Examples
SetStrProp Set object property via LabTalk property name Examples
SetTheme Set the theme as treenode


OriginBase Members

Name Brief Example
IsValid Check whether the instance is valid Examples