Warning, /office/calligra/sheets/functions/reference.xml is written in an unsupported language. File is not indexed.
0001 <!DOCTYPE KSpreadFunctions>
0002 <KSpreadFunctions>
0003
0004 <Group>
0005 <GroupName>Lookup & Reference</GroupName>
0006
0007 <Function>
0008 <Name>ADDRESS</Name>
0009 <Type>String</Type>
0010 <Parameter>
0011 <Comment>Row number</Comment>
0012 <Type>Int</Type>
0013 </Parameter>
0014 <Parameter>
0015 <Comment>Column number</Comment>
0016 <Type>Int</Type>
0017 </Parameter>
0018 <Parameter>
0019 <Comment>Absolute number (optional)</Comment>
0020 <Type>Int</Type>
0021 </Parameter>
0022 <Parameter>
0023 <Comment>A1 style (optional)</Comment>
0024 <Type>Boolean</Type>
0025 </Parameter>
0026 <Parameter>
0027 <Comment>Sheet name</Comment>
0028 <Type>String</Type>
0029 </Parameter>
0030 <Help>
0031 <Text>The ADDRESS creates a cell address. Parameter Row is the row number and Column is the column number.</Text>
0032 <Text>Absolute number specifies the type of reference: 1 or omitted = Absolute, 2 = Absolute row, relative column, 3 = Relative row; absolute column and 4 = Relative.</Text>
0033 <Text>A1 Style specifies the style of the address to return. If A1 is set to TRUE (default) the address is returned in A1 style if it is set to FALSE in R1C1 style.</Text>
0034 <Text>Sheet name is the text specifying the name of the sheet.</Text>
0035 <Syntax>ADDRESS(row; col; absolute; style; sheet name)</Syntax>
0036 <Example>ADDRESS(6; 4) returns $D$6</Example>
0037 <Example>ADDRESS(6; 4; 2) returns D$6</Example>
0038 <Example>ADDRESS(6; 4; 2; FALSE; "Sheet1") returns Sheet1!R6C[4]</Example>
0039 <Example>ADDRESS(6; 4; 1; FALSE; "Sheet1") returns Sheet1!R6C4</Example>
0040 <Example>ADDRESS(6; 4; 4; TRUE; "Sheet1") returns Sheet1!D6</Example>
0041 </Help>
0042 </Function>
0043
0044 <Function>
0045 <Name>AREAS</Name>
0046 <Type>Int</Type>
0047 <Parameter>
0048 <Comment>Reference</Comment>
0049 <Type range="true">String</Type>
0050 </Parameter>
0051 <Help>
0052 <Text>Returns the number of areas in the reference string. An area can be asingle cell or a set of cells.</Text>
0053 <Syntax>AREAS(reference)</Syntax>
0054 <Example>AREAS(A1) returns 1</Example>
0055 <Example>AREAS((A1; A2:A4)) returns 2</Example>
0056 </Help>
0057 </Function>
0058
0059 <Function>
0060 <Name>CELL</Name>
0061 <Type>Any</Type>
0062 <Parameter>
0063 <Comment>Type</Comment>
0064 <Type>String</Type>
0065 </Parameter>
0066 <Parameter>
0067 <Comment>Reference</Comment>
0068 <Type range="true">Reference</Type>
0069 </Parameter>
0070 <Help>
0071 <Text>Returns information about position, formatting or contents in a reference.</Text>
0072 <Syntax>CELL(type; reference)</Syntax>
0073 <Example>CELL("COL", C7) returns 3</Example>
0074 <Example>CELL("ROW", C7) returns 7</Example>
0075 <Example>CELL("ADDRESS", C7) returns $C$7</Example>
0076 </Help>
0077 </Function>
0078
0079 <Function>
0080 <Name>CHOOSE</Name>
0081 <Parameter>
0082 <Comment>Index</Comment>
0083 <Type>Int</Type>
0084 </Parameter>
0085 <Parameter>
0086 <Comment>Arguments</Comment>
0087 </Parameter>
0088 <Help>
0089 <Text>Returns the parameter specified by the index.</Text>
0090 <Syntax>CHOOSE(index; parameter1; parameter2;...)</Syntax>
0091 <Example>CHOOSE(1; "1st"; "2nd") returns "1st"</Example>
0092 <Example>CHOOSE(2; 3; 2; 4) returns 2</Example>
0093 </Help>
0094 </Function>
0095
0096 <Function>
0097 <Name>COLUMN</Name>
0098 <Type>Int</Type>
0099 <Parameter>
0100 <Comment>Reference</Comment>
0101 <Type>String</Type>
0102 </Parameter>
0103 <Help>
0104 <Text>The COLUMN function returns the column of given cell reference. If no parameter is specified the column of the current cell gets returned.</Text>
0105 <Syntax>COLUMN(reference)</Syntax>
0106 <Example>COLUMN(A1) returns 1</Example>
0107 <Example>COLUMN(D2) returns 4</Example>
0108 <Related>COLUMNS</Related>
0109 <Related>ROW</Related>
0110 </Help>
0111 </Function>
0112
0113 <Function>
0114 <Name>COLUMNS</Name>
0115 <Type>Int</Type>
0116 <Parameter>
0117 <Comment>Reference</Comment>
0118 <Type>String</Type>
0119 </Parameter>
0120 <Help>
0121 <Text>The COLUMNS function returns the number of columns in a reference.</Text>
0122 <Syntax>COLUMNS(reference)</Syntax>
0123 <Example>COLUMNS(A1:C3) returns 3</Example>
0124 <Example>COLUMNS(D2) returns 1</Example>
0125 <Related>COLUMN</Related>
0126 <Related>ROWS</Related>
0127 </Help>
0128 </Function>
0129
0130 <Function>
0131 <Name>INDEX</Name>
0132 <Parameter>
0133 <Comment>Reference</Comment>
0134 <Type>String</Type>
0135 </Parameter>
0136 <Parameter>
0137 <Comment>Row</Comment>
0138 <Type>Int</Type>
0139 </Parameter>
0140 <Parameter>
0141 <Comment>Column</Comment>
0142 <Type>Int</Type>
0143 </Parameter>
0144 <Help>
0145 <Text>If a range is given, returns value stored in a given row/column. If one cell is given, which contains an array, then one element of the array is returned.</Text>
0146 <Syntax>INDEX(cell, row, column)</Syntax>
0147 <Syntax>INDEX(range, row, column)</Syntax>
0148 <Example>INDEX(A1:C3;2;2), returns contents of B2</Example>
0149 <Example>INDEX(A1;2;2), if A1 is a result of array calculation, returns its (2,2) element.</Example>
0150 </Help>
0151 </Function>
0152
0153 <Function>
0154 <Name>INDIRECT</Name>
0155 <Parameter>
0156 <Comment>Reference</Comment>
0157 <Type>String</Type>
0158 </Parameter>
0159 <Parameter>
0160 <Comment>A1 style (optional)</Comment>
0161 <Type>Boolean</Type>
0162 </Parameter>
0163 <Help>
0164 <Text>Returns the content of the cell specified by the reference text. The second parameter is optional.</Text>
0165 <Syntax>INDIRECT(referenceText, a1 style)</Syntax>
0166 <Example>INDIRECT(A1), A1 contains "B1", and B1 1 => returns 1</Example>
0167 <Example>INDIRECT("A1"), returns content of A1</Example>
0168 </Help>
0169 </Function>
0170
0171 <Function>
0172 <Name>ROW</Name>
0173 <Type>Int</Type>
0174 <Parameter>
0175 <Comment>Reference</Comment>
0176 <Type>String</Type>
0177 </Parameter>
0178 <Help>
0179 <Text>The ROW function returns the row of given cell reference. If no parameter is specified the row of the current cell gets returned.</Text>
0180 <Syntax>ROW(reference)</Syntax>
0181 <Example>ROW(A1) returns 1</Example>
0182 <Example>ROW(D2) returns 2</Example>
0183 <Related>ROWS</Related>
0184 <Related>COLUMN</Related>
0185 </Help>
0186 </Function>
0187
0188 <Function>
0189 <Name>ROWS</Name>
0190 <Type>Int</Type>
0191 <Parameter>
0192 <Comment>Reference</Comment>
0193 <Type>String</Type>
0194 </Parameter>
0195 <Help>
0196 <Text>The ROWS function returns the number of rows in a reference.</Text>
0197 <Syntax>ROWS(reference)</Syntax>
0198 <Example>ROWS(A1:C3) returns 3</Example>
0199 <Example>ROWS(D2) returns 1</Example>
0200 <Related>ROW</Related>
0201 <Related>COLUMNS</Related>
0202 </Help>
0203 </Function>
0204
0205 <Function>
0206 <Name>SHEET</Name>
0207 <Type>Int</Type>
0208 <Parameter>
0209 <Comment>Reference</Comment>
0210 <Type>Reference</Type>
0211 </Parameter>
0212 <Help>
0213 <Text>Returns the sheet number of the reference or the string representing a sheet name.</Text>
0214 <Syntax>SHEET(reference)</Syntax>
0215 <Example>SHEET(Sheet1!C7) returns 1</Example>
0216 <Example>SHEET(Sheet2!C7) returns 2</Example>
0217 </Help>
0218 </Function>
0219
0220 <Function>
0221 <Name>SHEETS</Name>
0222 <Type>Int</Type>
0223 <Parameter>
0224 <Comment>Reference</Comment>
0225 <Type>Reference</Type>
0226 </Parameter>
0227 <Help>
0228 <Text>Returns the number of sheets in a reference or current document.</Text>
0229 <Syntax>SHEETS(reference)</Syntax>
0230 </Help>
0231 </Function>
0232
0233 <Function>
0234 <Name>LOOKUP</Name>
0235 <Parameter>
0236 <Comment>Lookup value</Comment>
0237 <Type>String/Numeric</Type>
0238 </Parameter>
0239 <Parameter>
0240 <Comment>Lookup vector</Comment>
0241 <Type>String/Numeric</Type>
0242 </Parameter>
0243 <Parameter>
0244 <Comment>Result vector</Comment>
0245 <Type>String/Numeric</Type>
0246 </Parameter>
0247 <Help>
0248 <Text>The LOOKUP function looks up the first parameter in the lookup vector. It returns a value in the result Vector with the same index as the matching value in the lookup vector. If value is not in the lookup vector it takes the next lower one. If no value in the lookup vector matches an error is returned. The lookup vector must be in ascending order and lookup and result vector must have the same size. Numeric values, string and boolean values are recognized. Comparison between strings is case-insensitive.</Text>
0249 <Syntax>LOOKUP(value; lookup vector; result vector)</Syntax>
0250 <Example>LOOKUP(1.232; A1:A6; B1:B6) for A1 = 1, A2 = 2 returns the value of B1.</Example>
0251 </Help>
0252 </Function>
0253
0254 <Function>
0255 <Name>HLOOKUP</Name>
0256 <Type>String/Numeric</Type>
0257 <Parameter>
0258 <Comment>Lookup value</Comment>
0259 <Type>String/Numeric</Type>
0260 </Parameter>
0261 <Parameter>
0262 <Comment>Data source</Comment>
0263 <Type>Array</Type>
0264 </Parameter>
0265 <Parameter>
0266 <Comment>Row</Comment>
0267 <Type>Int</Type>
0268 </Parameter>
0269 <Parameter>
0270 <Comment>Sorted (optional)</Comment>
0271 <Type>Boolean</Type>
0272 </Parameter>
0273 <Help>
0274 <Text>Look for a matching value in the first row of the given table, and return the value of the indicated row.</Text>
0275 <Text>Looks up the 'lookup value' in the first row of the 'data source'. If a value matches, the value in the 'row' and the column, the value was found in, is returned. If 'sorted' is true (default), the first row is assumed to be sorted. The search will end, if the 'lookup value' is lower than the value, currently compared to.</Text>
0276 <Syntax>HLOOKUP(Lookup value; data source; Row; Sorted)</Syntax>
0277 </Help>
0278 </Function>
0279
0280 <Function>
0281 <Name>VLOOKUP</Name>
0282 <Type>String/Numeric</Type>
0283 <Parameter>
0284 <Comment>Lookup value</Comment>
0285 <Type>String/Numeric</Type>
0286 </Parameter>
0287 <Parameter>
0288 <Comment>Data source</Comment>
0289 <Type>Array</Type>
0290 </Parameter>
0291 <Parameter>
0292 <Comment>Column</Comment>
0293 <Type>Int</Type>
0294 </Parameter>
0295 <Parameter>
0296 <Comment>Sorted (optional)</Comment>
0297 <Type>Boolean</Type>
0298 </Parameter>
0299 <Help>
0300 <Text>Look for a matching value in the first column of the given table, and return the value of the indicated column.</Text>
0301 <Text>Looks up the 'lookup value' in the first column of the 'data source'. If a value matches, the value in the 'column' and the row, the value was found in, is returned. If 'sorted' is true (default), the first column is assumed to be sorted. The search will end, if the 'lookup value' is lower than the value, currently compared to.</Text>
0302 <Syntax>VLOOKUP(Lookup value; data source; Column; Sorted)</Syntax>
0303 </Help>
0304 </Function>
0305
0306 <Function>
0307 <Name>MULTIPLE.OPERATIONS</Name>
0308 <Type>String/Numeric</Type>
0309 <Parameter>
0310 <Comment>Formula cell</Comment>
0311 <Type>Reference</Type>
0312 </Parameter>
0313 <Parameter>
0314 <Comment>Row cell</Comment>
0315 <Type>Reference</Type>
0316 </Parameter>
0317 <Parameter>
0318 <Comment>Row replacement</Comment>
0319 <Type>Reference</Type>
0320 </Parameter>
0321 <Parameter>
0322 <Comment>Column cell (optional)</Comment>
0323 <Type>Reference</Type>
0324 </Parameter>
0325 <Parameter>
0326 <Comment>Column replacement (optional)</Comment>
0327 <Type>Reference</Type>
0328 </Parameter>
0329 <Help>
0330 <Text>MULTIPLE.OPERATIONS executes the formula expression pointed to by FormulaCell and all formula expressions it depends on while replacing all references to RowCell with references to RowReplacement respectively all references to ColumnCell with references to ColumnReplacement. The function may be used to easily create tables of expressions that depend on two input parameters.</Text>
0331 <Syntax>MULTIPLE.OPERATIONS(Formula cell; Row cell; Row replacement; Column cell; Column replacement)</Syntax>
0332 </Help>
0333 </Function>
0334
0335 <Function>
0336 <Name>MATCH</Name>
0337 <Type>Int</Type>
0338 <Parameter>
0339 <Comment>Search value</Comment>
0340 <Type>String/Numeric</Type>
0341 </Parameter>
0342 <Parameter>
0343 <Comment>Search region</Comment>
0344 <Type>Reference/Array</Type>
0345 </Parameter>
0346 <Parameter>
0347 <Comment>Match type (optional)</Comment>
0348 <Type>Int</Type>
0349 </Parameter>
0350 <Help>
0351 <Text>Finds a search value in a search region, and returns its position (starting from 1). Match type can be either -1, 0 or 1 and determines how is searched for the value. If match type is 0, the index of the first value that equals search value is returned. If match type is 1 (or omitted), the index of the first value that is less than or equal to the search value is returned and the values in the search region must be sorted in ascending order. If match type is -1, the smallest value that is greater than or equal to the search value is found, and the search region needs to be sorted in descending order.</Text>
0352 <Syntax>MATCH(Search value; Search region; Match type)</Syntax>
0353 </Help>
0354 </Function>
0355
0356 <Function>
0357 <Name>OFFSET</Name>
0358 <Type>Reference</Type>
0359 <Parameter>
0360 <Comment>Reference or range</Comment>
0361 <Type>Reference</Type>
0362 </Parameter>
0363 <Parameter>
0364 <Comment>Number of rows to offset</Comment>
0365 <Type>Int</Type>
0366 </Parameter>
0367 <Parameter>
0368 <Comment>Number of columns to offset</Comment>
0369 <Type>Int</Type>
0370 </Parameter>
0371 <Parameter>
0372 <Comment>Height of the offset range (optional)</Comment>
0373 <Type>Int</Type>
0374 </Parameter>
0375 <Parameter>
0376 <Comment>Width of the offset range (optional)</Comment>
0377 <Type>Int</Type>
0378 </Parameter>
0379 <Help>
0380 <Text>Modifies a reference's position and dimension.</Text>
0381 <Syntax>OFFSET(Reference reference; Integer rowOffset; Integer columnOffset; Integer newHeight; Integer newWidth)</Syntax>
0382 </Help>
0383 </Function>
0384 </Group>
0385
0386 </KSpreadFunctions>