Skip to content
Permalink
Browse files

Clarify numeric and any types

* Clarify numeric and any types
* Update README
  • Loading branch information...
williamscraigm committed Mar 4, 2019
1 parent 070e2cb commit 7d2c1697d6f3803471c6bd7fdc6bf9bd1bdf37b0
@@ -10,9 +10,11 @@ Usage of the CIM primarily begins with an entry point through a primary object.
- Styles : A database with style items defining graphic objects like [colors](docs/v2/Types.md#color), [colors schemes](docs/v2/Types.md#colorramp), and [symbols](docs/v2/Types.md#symbol) used to draw a feature or layout graphic. These items are used in the definitions of layers, maps, scenes, and layouts but may also be stored on their own as items in styles where the JSON is written to a database field. See also [An overview of symbols in the CIM](docs/v2/Overview-Symbols.md).

## How this specification is formatted
This CIM specification is documented via Markdown documents that contain definitions for objects and their properties. JSON lacks an inheritance mechanism and CIM implementations often deal with many abstract types using inheritance. The formatting of the Markdown reflects these realities in the following ways:
This CIM specification is documented via Markdown documents that contain definitions for objects and their properties. JSON lacks an inheritance mechanism and CIM implementations often deal with many abstract types using inheritance. Additionally, JSON has one numeric type, but typed languages typically differentiate various integer and floating-point types. The formatting of the Markdown reflects these realities in the following ways:
1. Objects that can be thought of inheriting from a type list properties in a section for each inherited type. In some cases, the final type may inherit all properties from another type and have no unique properties for itself. See [CIMRGBColor](CIMColor.md#CIMRGBColor) for an example.
2. The [Types](docs/v2/Types.md) document lists objects by their type for quick reference.
3. Numeric types are specified as `short`, `long`, `long long`, `float`, and `double` corresponding to 16-bit integer, 32-bit integer, 64-bit integer, single-precision floating-point, and double-precision floating-point types respectively.
4. Types specified as `any` may be any basic JSON type: `string`, `number`, `boolean`, or `null`.

## Versioning

@@ -131,7 +131,7 @@
|Property | Type | Description |
|---------|--------|--------|
| actions | [CIMLayerAction](CIMVectorLayers.md#cimlayeraction) | The layer actions.
| exclusionSet | [long64] | The set of excluded features.
| exclusionSet | [long long] | The set of excluded features.
| featureMasks | [CIMDataConnection](Types.md#dataconnection) | The data connection of the masking data.
| labelClasses | [CIMLabelClass](CIMLabelPlacement.md#cimlabelclass) | The collection of label class definitions.
| labelVisibility | boolean | A value indicating whether to display labels for this layer's label classes.
@@ -431,11 +431,11 @@
|Property | Type | Description |
|---------|--------|--------|
| ascending | boolean | A value indicating whether the mosaic rule uses ascending order.
| FIDs | [long64] | An array of IDs.
| FIDs | [long long] | An array of IDs.
| lockRasterID | string | The ID of the lock raster.
| mosaicMethod | [enumeration RasterMosaicMethod](CIMImageLayers.md#enumeration-rastermosaicmethod) | The mosaic method.
| mosaicOperatorType | [enumeration RasterMosaicOperatorType](CIMImageLayers.md#enumeration-rastermosaicoperatortype) | The mosaic operator type.
| orderByBaseValue | VARIANT | The order by base value.
| orderByBaseValue | any | The order by base value.
| orderByFieldName | string | The order by field name.
| timeValue | [TimeValue](ExternalReferences.md#timevalue) | The time value.
| viewpoint | [Point](ExternalReferences.md#point) | The viewpoint as a point.
@@ -72,8 +72,8 @@
| dateTimeFormat | string | The format string for axis date/time labels.
| calculateAutomaticMinimum | boolean | A value indicating whether the chart axis calculates its minimum.
| calculateAutomaticMaximum | boolean | A value indicating whether the chart axis calculates its maximum.
| minimum | VARIANT | The minimum of the axis.
| maximum | VARIANT | The maximum of the axis.
| minimum | any | The minimum of the axis.
| maximum | any | The maximum of the axis.
| titleText | [CIMChartTextProperties](CIMLayer.md#cimcharttextproperties) | The title symbol properties.
| labelText | [CIMChartTextProperties](CIMLayer.md#cimcharttextproperties) | The label symbol properties.
| axisLineSymbolProperties | [CIMChartLineSymbolProperties](CIMLayer.md#cimchartlinesymbolproperties) | The line symbol properties for axis.
@@ -526,8 +526,8 @@
| rightImage | [DataConnection](Types.md#dataconnection) | The right image of the stereo pair.
| sourceType | [enumeration StereoSourceType](CIMMap.md#enumeration-stereosourcetype) | The stereo source type.
| stereoModelCollection | [DataConnection](Types.md#dataconnection) | The data connection to the source stereo model collection.
| leftImageID | long64 | The OID of the left image of the current stereo model in a collection.
| rightImageID | long64 | The OID of the right image of the current stereo model in a collection.
| leftImageID | long long | The OID of the left image of the current stereo model in a collection.
| rightImageID | long long | The OID of the right image of the current stereo model in a collection.
| leftImageColorizer | [CIMRasterColorizer](CIMImageLayers.md#cimrastercolorizer) | The colorizer for the left image.
| rightImageColorizer | [CIMRasterColorizer](CIMImageLayers.md#cimrastercolorizer) | The colorizer for the right image.
| adjustColorizersInSync | boolean | A value indicating whether adjustments to either colorizer should be synced to the other.
@@ -595,7 +595,7 @@
| labelVisibility | boolean | A value indicating whether to display labels for this layer's label classes.
| dataConnection | [CIMSceneDataConnection](CIMTerrainLayers.md#cimscenedataconnection) | The data connection. Currently used only when loading local scene layer packages.
| useRealWorldSymbolSizes | boolean | A value indicating whether to use real world symbols sizes (meters) vs. points.
| exclusionSet | [long64] | The set of excluded features.
| exclusionSet | [long long] | The set of excluded features.
| definitionExpression | string | The definition expression that can subset the features.
| definitionExpressionName | string | The Name of definition expression.
| definitionFilterChoices | [CIMDefinitionFilter](CIMLayer.md#cimdefinitionfilter) | The definition filter choices.
@@ -192,7 +192,7 @@
|---------|--------|--------|
| name | string | The name.
| CGAAttributeType | [enumeration CGAAttributeType](CIMSymbols.md#enumeration-cgaattributetype) | The CGA attribute type.
| value | VARIANT | The value.
| value | any | The value.



@@ -528,8 +528,8 @@

|Property | Type | Description |
|---------|--------|--------|
| defaultValue | ["<string>" / <number> / {JSON_object}]| The variable's required default value. The array can have multiple values only if AllowMultiple is true.
| boundValue | ["<string>" / <number> / {JSON_object}]| The variable's currently-bound value. The array can have multiple values only if AllowMultiple is true.
| defaultValue | [any]| The variable's required default value. The array can have multiple values only if AllowMultiple is true.
| boundValue | [any]| The variable's currently-bound value. The array can have multiple values only if AllowMultiple is true.
| allowMultiple | boolean | A value indicating whether the variable will accept an array of values.


@@ -750,7 +750,7 @@
|Property | Type | Description |
|---------|--------|--------|
| actions | [CIMLayerAction](CIMVectorLayers.md#cimlayeraction) | The layer actions.
| exclusionSet | [long64] | The set of excluded features.
| exclusionSet | [long long] | The set of excluded features.
| featureMasks | [CIMDataConnection](Types.md#dataconnection) | The data connection of the masking data.
| labelClasses | [CIMLabelClass](CIMLabelPlacement.md#cimlabelclass) | The collection of label class definitions.
| labelVisibility | boolean | A value indicating whether to display labels for this layer's label classes.
@@ -1220,7 +1220,7 @@
| invertRows | boolean | A value indicating whether or not to invert rows.
| selectedDimensionIndexes | [long] | The selected dimension indexes.
| selectedDimensions | [string] | The selected dimensions.
| selectedDimensionValues | ["<string>" / <number> / {JSON_object}]| The selected dimension values.
| selectedDimensionValues | [any]| The selected dimension values.
| variable | string | The variable.
| verticalDimension | string | The vertical dimension.
| verticalDimensionUnit | string | The vertical dimension unit.
@@ -1265,7 +1265,7 @@
| MDimension | string | The M dimension.
| selectedDimensions | [string] | The selected dimensions.
| selectedDimensionIndexes | [long] | The selected dimension indexes.
| selectedDimensionValues | ["<string>" / <number> / {JSON_object}]| The selected dimension values.
| selectedDimensionValues | [any]| The selected dimension values.
| shapeFieldName | string | The shape field name.
| verticalDimension | string | The vertical dimension.
| verticalDimensionUnit | string | The vertical dimension unit.
@@ -1467,8 +1467,8 @@
|---------|--------|--------|
| fieldExpression | string | The field for which the value range will be specified.
| optional | boolean | A value indicating whether this variable is optional. If not, default values must be provided.
| defaultMin | VARIANT | The default minimum value.
| defaultMax | VARIANT | The default maximum value.
| defaultMin | any | The default minimum value.
| defaultMax | any | The default maximum value.
| tableName | string | The name of the table to which the field in FieldExpression belongs.
| valueIfMissing | boolean | A value indicating whether the resulting expression should take if the variable is optional and no value is passed.

@@ -1753,8 +1753,8 @@
|Property | Type | Description |
|---------|--------|--------|
| featureExpirationMethod | [enumeration FeatureExpirationMethod](CIMVectorLayers.md#enumeration-featureexpirationmethod) | Feature expiration method used at dataset level.
| maximumFeatureCount | long64 | The maximum number of features that are held in memory before features are discarded.
| maximumFeatureAge | long64 | The maximum age for each feature before the feature is discarded.
| maximumFeatureCount | long long | The maximum number of features that are held in memory before features are discarded.
| maximumFeatureAge | long long | The maximum age for each feature before the feature is discarded.



@@ -262,11 +262,11 @@ A Multipoint is a collection of Points. A multipoint is a one-dimensional geome
|---------|--------|--------|
|name | string | Name that identifies the material.|
|color | [Color](CIMColor.md#CIMColor)| Color of the material.|
|shininess| integer | Shininess of the material ranging from 0 to 255 inclusive.|
|shininess| short | Shininess of the material ranging from 0 to 255 inclusive.|
|transparency| double | Transparency of the material ranging from 0 and 100 inclusive.|
|cull| boolean | Indicates the
|edgeColor| [Color](CIMColor.md#CIMColor)| Edge color.|
|edgeWidth| integer | Width of the edge ranging from 0 and 255 inclusive.|
|edgeWidth| short | Width of the edge ranging from 0 and 255 inclusive.|
|texture| string | base64 encoded texture image.|
|textureUrl| string | URL of texture image.|
|sharedTexture| string | Name of the material that contains the actual texture.|

0 comments on commit 7d2c169

Please sign in to comment.
You can’t perform that action at this time.