Function Arguments
The following listing shows each of the different arguments or 'input' values expected in the various PQL and MDX functions within Pyramid.
|
An integer whole number representing the axis index. Columns are 0, Rows are 1, Pages are 2 etc. |
|
|
Backgound color represented as either a 6 character hexadecimal, color name or RGB string. |
|
|
A whole number value to represent the color blue between 0 and 255. |
|
|
A value only two possible values usually 'true' or '1' and 'false' or '0' |
|
|
An comma delimited list of expressions that needs to be evaluated to true or false. |
|
|
A positive integer whole number representing the column index - starting from 0. |
|
|
The initial cost of the asset. |
|
|
An expression that evaluate to true or false for conditional logic and filters. |
|
|
A list or collection of different criteria expressions. |
|
|
A cube name as a text. |
|
|
A data point, or 'tuple', is a composition representing a selection of one member from one or more columns/attributes in your model. It effectively demarcates a specific data cell in the model, including a measure. |
|
|
The a value or expression that represents a date. |
|
|
The a text value or expression that represents a date. |
|
|
A date and time value that includes both data information and specific time information. |
|
|
A positive whole number value to represent a 'second' 0-31 |
|
|
The default value. |
|
|
A text character that will be used to differentiate the items in a list. |
|
|
A dimension or table is a collection of columns. |
|
|
A positive whole number representing the ending or last index. |
|
|
The number of milliseconds since 1970-01-01. |
|
|
An expression that evaluates to true or false |
|
|
A boolean value indicating 'false' - usually '0' |
|
|
A text indicator value that provides details for how the function should run. |
|
|
An integer value that indicates which details the function should return. |
|
|
Simple text representing the name of the font to use. |
|
|
The number of periods to forecast into the future. |
|
|
Foreground color represented as either a 6 character hexadecimal, color name or RGB string. |
|
|
A whole number value to represent the color green between 0 and 255. |
|
|
A positive whole number representing the height of the item in pixels |
|
|
A hierarchy is usually a column in a dimension/table of a model. A multi-level 'regular' hierarchy is a composite structure of multiple columns. While an attribute hierarchy is typically a single column. |
|
|
A collection or array of hierarchy entities. |
|
|
A positive whole number value to represent an 'hour' from 0 to 23 |
|
|
A whole number value. Depending on the function, this can be a value in the range from -2b up to +2b. |
|
|
The numerical difference between one range and the next. |
|
|
A KPI member or element found in the KPIs list of a model. |
|
|
The latitude for a global point |
|
|
A level is usually a single column found in a multi-level 'regular' hierarchy derived from dimensions/tables. |
|
|
The length of the useful life of the asset. |
|
|
A list or 'set' is a collection of data points or 'tuples' from one or more hierarchies in the model. |
|
|
The longitude for a global point |
|
|
A positive whole number representing the number of loop iterations to perform |
|
|
A defined text string used to describe how to format numbers or dates |
|
|
A measure member or element found in the measures list of a model. |
|
|
A member is an element entity found in a column/hierarchy. |
|
|
The name of the group of measures as defined in the model. |
|
|
The name of a mining model used for prediction calculations. |
|
|
A positive whole number value to represent a 'minute' 0-59 |
|
|
A positive whole number value to represent a 'month' 1-12 |
|
|
A numeric value that is usually any positive or negative floating number with decimals, but can also include integers. |
|
|
A list of numeric items usually represented as a collection or array |
|
|
A comma delimited list of numeric values that are usually any positive or negative numbers. |
|
|
A regular expression pattern string |
|
|
The total number of payment periods in the annuity. |
|
|
The payment to be made each period. |
|
|
The period for which asset depreciation is calculated. |
|
|
The total number of payment periods in the annuity. |
|
|
A positive whole number value to represent a 'period'. |
|
|
A integer value representing the type of period to use. |
|
|
The number of decimal positions used in the rounded value. |
|
|
The current or present value (or lump sum) of a series of future payments. |
|
|
A positive whole number value to represent a 'quarter' 1-4 |
|
|
A integer value representing the type of period range to use. |
|
|
The interest rate per period. |
|
|
A whole number value to represent the color red between 0 and 255. |
|
|
The interest rate received on gains from cash reinvestment. |
|
|
The replacement text or string. |
|
|
A list or collection of different result expressions corresponding to the matching criteria list expressions. |
|
|
A positive integer whole number representing the row index - starting from 0. |
|
|
The value of the asset at the end of its useful life. |
|
|
The search text or string. |
|
|
A positive whole number value to represent a 'second' 0-59 |
|
|
A positive whole number representing the size of the font in pixels |
|
|
The number that is the start of the overall range of numbers. |
|
|
A positive whole number representing the starting or first index. |
|
|
A comma delimtied list of result values that correspond to the matching case expression. |
|
|
The number that is the end of the overall range of numbers. |
|
|
A simple text or 'string' value, containing alphanumeric characters. |
|
|
A list of text or string items usually represented as a collection or array. |
|
|
A comma delimtied list of text items. |
|
|
The a value or expression that represents a time. |
|
|
A boolean value indicating 'true' - usually '1' |
|
|
A text string representing the URL of the item. |
|
|
A data point or expression that is used for the evaluation. |
|
|
A value that will depend on the context in which the function is used. Usually the result is either numeric or text (string) |
|
|
A list of variante items usually represented as a collection or array. |
|
|
A positive whole number value to represent a 'week' 0-52 |
|
|
A positive whole number representing the width of the item in pixels |
|
|
A positive whole number value to represent a 'year' |