Function Arguments

The following listing shows each of the different arguments or 'input' values expected in the various PQL and MDX functions within Pyramid.

Axis Integer

An integer whole number representing the axis index. Columns are 0, Rows are 1, Pages are 2 etc.

Back Color

Backgound color represented as either a 6 character hexadecimal, color name or RGB string.

Blue Integer

A whole number value to represent the color blue between 0 and 255.

Boolean

A value only two possible values usually 'true' or '1' and 'false' or '0'

Case N

An comma delimited list of expressions that needs to be evaluated to true or false.

Column Integer

A positive integer whole number representing the column index - starting from 0.

Cost

The initial cost of the asset.

Criteria

An expression that evaluate to true or false for conditional logic and filters.

Criteria List

A list or collection of different criteria expressions.

Cube

A cube name as a text.

Data Point

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.

Date

The a value or expression that represents a date.

Date Text

The a text value or expression that represents a date.

Date-Time

A date and time value that includes both data information and specific time information.

Day Integer

A positive whole number value to represent a 'second' 0-31

Default

The default value.

Delimiter

A text character that will be used to differentiate the items in a list.

Dimension

A dimension or table is a collection of columns.

End Integer

A positive whole number representing the ending or last index.

Epoch Time

The number of milliseconds since 1970-01-01.

Expression

An expression that evaluates to true or false

FALSE

A boolean value indicating 'false' - usually '0'

Flag

A text indicator value that provides details for how the function should run.

Font Family

Simple text representing the name of the font to use.

Forecast Periods

The number of periods to forecast into the future.

Fore Color

Foreground color represented as either a 6 character hexadecimal, color name or RGB string.

Green Integer

A whole number value to represent the color green between 0 and 255.

Height

A positive whole number representing the height of the item in pixels

Hierarchy

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.

Hierarchy List

A collection or array of hierarchy entities.

Hour Integer

A positive whole number value to represent an 'hour' from 0 to 23

Integer

A whole number value. Depending on the function, this can be a value in the range from -2b up to +2b.

Interval

The numerical difference between one range and the next.

KPI

A KPI member or element found in the KPIs list of a model.

Level

A level is usually a single column found in a multi-level 'regular' hierarchy derived from dimensions/tables.

Life

The length of the useful life of the asset.

List

A list or 'set' is a collection of data points or 'tuples' from one or more hierarchies in the model.

Loop Iterations

A positive whole number representing the number of loop iterations to perform

Mask

A defined text string used to describe how to format numbers or dates

Measure

A measure member or element found in the measures list of a model.

Member

A member is an element entity found in a column/hierarchy.

Measure Group

The name of the group of measures as defined in the model.

Mining Model

The name of a mining model used for prediction calculations.

Minute Integer

A positive whole number value to represent a 'minute' 0-59

Month Integer

A positive whole number value to represent a 'month' 1-12

Numeric

A numeric value that is usually any positive or negative floating number with decimals, but can also include integers.

Numeric List

A list of numeric items usually represented as a collection or array

Numeric N

A comma delimited list of numeric values that are usually any positive or negative numbers.

Pattern String

A regular expression pattern string

Payment Periods

The total number of payment periods in the annuity.

Payments

The payment to be made each period.

period

The period for which asset depreciation is calculated.

periods

The total number of payment periods in the annuity.

Periods Integer

A positive whole number value to represent a 'period'.

Period Type

A integer value representing the type of period to use.

Positions

The number of decimal positions used in the rounded value.

Present Value

The current or present value (or lump sum) of a series of future payments.

Quarter Integer

A positive whole number value to represent a 'quarter' 1-4

Range Type

A integer value representing the type of period range to use.

Rate

The interest rate per period. 

Red Integer

A whole number value to represent the color red between 0 and 255.

Reinvest

The interest rate received on gains from cash reinvestment.

Replace Text

The replacement text or string.

Result List

A list or collection of different result expressions corresponding to the matching criteria list expressions.

Row Integer

A positive integer whole number representing the row index - starting from 0.

Salvage

The value of the asset at the end of its useful life.

Search Text

The search text or string.

Second Integer

A positive whole number value to represent a 'second' 0-59

Size

A positive whole number representing the size of the font in pixels

Start

The number that is the start of the overall range of numbers. 

Start Integer

A positive whole number representing the starting or first index.

Statement N

A comma delimtied list of result values that correspond to the matching case expression.

Stop

The number that is the end of the overall range of numbers. 

Text

A simple text or 'string' value, containing alphanumeric characters.

Text List

A list of text or string items usually represented as a collection or array.

Text N

A comma delimtied list of text items.

Time

The a value or expression that represents a time.

TRUE

A boolean value indicating 'true' - usually '1'

URL

A text string representing the URL of the item.

Variable

A data point or expression that is used for the evaluation.

Variant

A value that will depend on the context in which the function is used. Usually the result is either numeric or text (string)

Variant List

A list of variante items usually represented as a collection or array.

Week Integer

A positive whole number value to represent a 'week' 0-52

Width

A positive whole number representing the width of the item in pixels

Year Integer

A positive whole number value to represent a 'year'