II. Server Side Services

II-5. Visibility/ Color Services

VCS001 setFeatureColor  

void setFeatureColor(string ck , int color) 5

where ck = CARIS Key and color = color index (within CARIS .cma file)

This method sets the color of a feature defined by CARISKey "ck" to the color specified by "color".

VCS002 resetFeatureColor

void resetFeatureColor(string ck )

where ck = CARIS Key

This method resets the color of a feature with CARISKey "ck" back to its default color.

VCS003 setFeatureColorAll

void setFeatureColorAll(string fcode , int color)

where fcode = Feature Code and color = color index (within CARIS .cma file)

This method sets the color of all features with the Feature Code "fcode" to the to the color specified by "color". "fcode" may contain wild cards (see Section II-6)

VCS004 resetFeatureColorAll

void resetFeatureColorAll(string fcode )

where fcode = FeatureCode

This method resets the color of all features with the Feature Code "fcode" back to the default color for "fcode". "fcode" may contain wild cards (see Section II-6)

VCS005 setFeatureVisibilityAll

void setFeatureVisibilityAll(Bool, string fcode)

where Bool = true for being visible

This method sets the visibility for a given feature code, which may contain wild cards (see Section II-6)

VCS006 setFeatureVisibility

void setFeatureVisibility( BOOL, string ck )

where BOOL = TRUE for being visible and ck is the CARIS key of any feature.

This method sets the visibility on or off for the feature identified by "ck".

VCS007 setLayerVisibility

void setLayerVisibility( BOOL flag, string layerName )

This functions works exactly like the "setFeatureVisibility" function, except that the 2nd argument is the name of a layer, instead of a feature code. This function should not be called, unless:

  1. "By Layer" has been selected and
  2. The given argument, layerName, has been defined in the project's profile.

VCS008 setSymbolizationOn

void setSymbolizationOn(BOOL flag)

This function turns symbolization of features on and off.

_______________________________________
5 If a client will add features, with feature codes that do not exist in the CARIS file, and it is desired that each unique feature type have its own color, then it is necessary to add these feature codes to the .col file, assigning a color index to each. Otherwise, these features will be displayed with the default color. back to main text

 

II-6. Server Side Services: Wild Card Services >>>>