Description
Instance Methods | |
| (double) | - convert:fromUnit: |
| (double) | - convert:toUnit: |
| (double) | - convertFromSquareMeters: |
| (double) | - convertToSquareMeters: |
| (nullable instancetype) | - initWithLinearUnit: |
| (nullable instancetype) | - initWithUnitID: |
| (BOOL) | - isEqualToUnit: |
| (nullable AGSLinearUnit *) | - toLinearUnit |
Class Methods | |
| (nullable instancetype) | + areaUnitWithLinearUnit: |
| (instancetype) | + squareFeet |
| (instancetype) | + squareKilometers |
| (instancetype) | + squareMeters |
| (instancetype) | + squareMiles |
| (nullable instancetype) | + unitWithUnitID: |
| (nullable instancetype) | + unitWithWKID: |
Properties | |
| NSString * | abbreviation |
| NSString * | displayName |
| NSString * | name |
| NSString * | pluralDisplayName |
| AGSAreaUnitID | unitID |
| NSInteger | WKID |
Method Documentation
◆ areaUnitWithLinearUnit:
| + (nullable instancetype) areaUnitWithLinearUnit: | (AGSLinearUnit *) | linearUnit |
Creates an area unit from the corresponding linear unit.
- Parameters
-
linearUnit The linear unit that you want to create an area unit from.
- Since
- 100
◆ convert:fromUnit:
| - (double) convert: | (double) | area | |
| fromUnit: | (AGSAreaUnit *) | fromUnit | |
Converts the value from the specified area unit into this unit.
- Parameters
-
area The area value to convert. fromUnit The units the given value is already in.
- Since
- 100
◆ convert:toUnit:
| - (double) convert: | (double) | area | |
| toUnit: | (AGSAreaUnit *) | toUnit | |
Converts the value from this unit to the specified area unit.
- Parameters
-
area The area value to convert. toUnit The units the converted value needs to be in.
- Since
- 100
◆ convertFromSquareMeters:
| - (double) convertFromSquareMeters: | (double) | area |
Converts the value from square meters into this unit.
- Parameters
-
area The are value to convert.
- Since
- 100
◆ convertToSquareMeters:
| - (double) convertToSquareMeters: | (double) | area |
Converts the value from this unit to square meters.
- Parameters
-
area The area value to convert.
- Since
- 100
◆ initWithLinearUnit:
| - (nullable instancetype) initWithLinearUnit: | (AGSLinearUnit *) | linearUnit |
Creates an area unit from the corresponding linear unit.
- Parameters
-
linearUnit The linear unit that you want to create an area unit from.
- Since
- 100
◆ initWithUnitID:
| - (nullable instancetype) initWithUnitID: | (AGSAreaUnitID) | unitID |
Creates an area unit.
- Parameters
-
unitID The area unit ID.
- Since
- 100
◆ isEqualToUnit:
| - (BOOL) isEqualToUnit: | (AGSUnit *) | unit |
Compares whether two units are equal.
- Parameters
-
unit to compare this one to
- Returns
- YES if the units are equal
- Since
- 100
◆ squareFeet
| + (instancetype) squareFeet |
An area unit representing square feet.
- Since
- 100
◆ squareKilometers
| + (instancetype) squareKilometers |
An area unit representing square kilometers.
- Since
- 100
◆ squareMeters
| + (instancetype) squareMeters |
An area unit representing square meters.
- Since
- 100
◆ squareMiles
| + (instancetype) squareMiles |
An area unit representing square miles.
- Since
- 100
◆ toLinearUnit
| - (nullable AGSLinearUnit*) toLinearUnit |
Returns the corresponding linear unit for this area unit.
- Since
- 100
◆ unitWithUnitID:
| + (nullable instancetype) unitWithUnitID: | (AGSAreaUnitID) | unitID |
Creates an area unit.
- Parameters
-
unitID The area unit ID.
- Since
- 100
◆ unitWithWKID:
| + (nullable instancetype) unitWithWKID: | (NSInteger) | WKID |
Create a unit with the given well-known ID (WKID). This allows you to create a unit from a WKID that is not in the associated UnitID enumeration.
- Parameters
-
WKID The well-known ID of the unit
- Since
- 100.7
Property Documentation
◆ abbreviation
|
readnonatomiccopyinherited |
Abbreviated name of the unit.
- Since
- 100
◆ displayName
|
readnonatomiccopyinherited |
A user-friendly name of the measurement unit.
- Since
- 100
◆ name
|
readnonatomiccopyinherited |
The name of the measurement unit.
- Since
- 100
◆ pluralDisplayName
|
readnonatomiccopyinherited |
A plural form of the user-friendly name.
- Since
- 100
◆ unitID
|
readnonatomicassign |
◆ WKID
|
readnonatomicassigninherited |
The well-known ID for the unit, or 0 for a custom unit.
- Since
- 100.14
