|
GLG Toolkit, JavaScript Library
Version 4.6
|
This group contains GLG constants.
Most constants are organized into groups based on their usage. Each group uses a separate JavaScript object, which is called "enum" in this documentation. In the code, enums are accessed as properties of the GLG Toolkit handle obtained via a 'new GlgToolkit()' call at the application start-up.
Grouped constants are accessed in the code as properties of their parent enums, while ungrouped constants are accessed as properties of the GLG Toolkit handle:
Constants | |
| const double | COORD_MAPPING_ADJ = 0.5 |
| Coordinate adjustement constant used to map the pixel index to the center of the pixel (i.e pixel #5 is mapped to coord=5.5). More... | |
| const double | EQUATOR_RADIUS = 6378136.0 |
| Equator radius in meters. More... | |
| const double | GIS_OUTSIDE_VALUE = -2000.0 |
| A negative value for Z coordinates of converted points outside of the visible part of the globe in the GIS orthographic projection. More... | |
| const int | MAJOR_VERSION = 4 |
| Major version number. More... | |
| const int | MINOR_VERSION = 6 |
| Minor version number. More... | |
| const double | POLAR_RADIUS = 6356752.0 |
| Polar radius in meters. More... | |
Enumerations | |
| enum class | GlgAccessType |
| Container access type. More... | |
| enum class | GlgActionType |
| Specifies an action type. More... | |
| enum class | GlgAnchoringType |
| Specifies anchoring type binary flags. More... | |
| enum class | GlgAnnotationType |
| Specifies a type of a chart's annotation. More... | |
| enum class | GlgAntiAliasingType |
| Specifies anti-aliasing type. More... | |
| enum class | GlgArcAngleDefType |
| Specifies the way the arc's start and end angles are used. More... | |
| enum class | GlgArcFillType |
| Specifies arc fill type. More... | |
| enum class | GlgArmedStateType |
| Choices of the armed_state parameter of the GetAction method that controls selection of the returned action object. More... | |
| enum class | GlgArrowFillTypeFlags |
| Arrow fill type constants. More... | |
| enum class | GlgArrowPositionFlags |
| Arrow position constants. More... | |
| enum class | GlgArrowPositionTypeMask |
| Arrow position and fill type masks. More... | |
| enum class | GlgArrowType |
| Specifies arrow type. More... | |
| enum class | GlgAxisDirection |
| Axis position and direction options. More... | |
| enum class | GlgAxisDirectionMask |
| Axis direction masks. More... | |
| enum class | GlgAxisOutlineFlags |
| Binary flags used to form GlgAxisOutlineType elements by combining them via bitwise OR. More... | |
| enum class | GlgAxisOutlineType |
| Axis outline type constants. More... | |
| enum class | GlgAxisType |
| Specifies axis type. More... | |
| enum class | GlgBoolConversionType |
| Specifies conversion type for parameters of the boolean transformation. More... | |
| enum class | GlgBoolXformType |
| Specifies the operation to be performed by the boolean transformation. More... | |
| enum class | GlgBoundType |
| Controls binding of a data object. More... | |
| enum class | GlgCallbackType |
| Specifies callback type. More... | |
| enum class | GlgCallEventType |
| Specifies the call event type for custom interaction handlers and installable interface handlers. More... | |
| enum class | GlgChartAutoScale |
| Specifies a type of a chart's autoscaling. More... | |
| enum class | GlgChartCacheUse |
| Controls the use of a per-plot chart cache. More... | |
| enum class | GlgChartElemDrawOrder |
| Controls drawing order of the chart's elements, may be combined with bitwise OR. More... | |
| enum class | GlgChartState |
| Flags for updating chart state, may be combined with bitwise OR. More... | |
| enum class | GlgChartTooltipMode |
| Specifies the interaction mode for the chart tooltip. More... | |
| enum class | GlgCloneType |
| Specifies clone type. More... | |
| enum class | GlgCompareXformType |
| Specifies the comparison operator of the compare transformation. More... | |
| enum class | GlgCompatibilityMode |
| Specifies compatibility mode. More... | |
| enum class | GlgComponentQueryType |
| Specifies a native component to return. More... | |
| enum class | GlgConfigureMask |
| Specifies window configuration masks that can be combined with bitwise OR. More... | |
| enum class | GlgContainerType |
| Specifies a type of objects to be held in a container object. More... | |
| enum class | GlgControlPointType |
| Specifies control point type. More... | |
| enum class | GlgConvexType |
| Specifies convex type of a polygon for OpenGL. More... | |
| enum class | GlgCoordType |
| Specifies coordinate types for transforming objects. More... | |
| enum class | GlgCursorType |
| Specifies a cursor type. More... | |
| enum class | GlgCustomSetupType |
| Indicates when the custom setup handler is invoked. More... | |
| enum class | GlgDataType |
| Data object types. More... | |
| enum class | GlgDoubleBufferingType |
| Specifies double buffering type. More... | |
| enum class | GlgDoubleClickStateType |
| Choices of the double_click_state parameter of the GetAction method that controls selection of the returned action object. More... | |
| enum class | GlgDrawingCoordSystem |
| Specifies the type of a drawing's coordinate system that defines the drawing's resize policy (CoordSystem attribute of the viewport screen). More... | |
| enum class | GlgElementDrawType |
| Controls existence and drawn order of the angular axis elements. More... | |
| enum class | GlgEnableXY |
| Specifies chart crosshair type. More... | |
| enum class | GlgErrorType |
| Specifies error message type for the Error method. More... | |
| enum class | GlgEventType |
| GLG event type constants. More... | |
| enum class | GlgExtDataFlag |
| Possible values of a plot's ExtendedData attribute. More... | |
| enum class | GlgExtDataType |
| Specifies type of information stored in the extended data sample. More... | |
| enum class | GlgFillSpace |
| Choices of filling extra space left by invisible elements in a square series. More... | |
| enum class | GlgFillType |
| Specifies polygon fill type binary flags that may be combined with bitwise OR operator. More... | |
| enum class | GlgFrameType |
| Specifies a frame object type. More... | |
| enum class | GlgFunctionXformType |
| Specifies the operation to be performed by the function transformation. More... | |
| enum class | GlgGISRequestFlags |
| GIS request flags that control which parameters of the GIS object will be updated by the request. More... | |
| enum class | GlgGISRequestStatus |
| GIS request status in request observer's RequestUpdate method. More... | |
| enum class | GlgGlobalType |
| Specifies global type of a data object that controls how it is cloned. More... | |
| enum class | GlgGradientType |
| Specifies gradient type. More... | |
| enum class | GlgGridType |
| Specifies chart grid type. More... | |
| enum class | GlgHandleInvisible |
| Choices of handling invisible cells by a square series. More... | |
| enum class | GlgHierarchyCallbackType |
| Indicates when the hierarchy callback is invoked. More... | |
| enum class | GlgHistoryScrollType |
| Specifies the scroll type of the History object. More... | |
| enum class | GlgImageType |
| Specifies image object type. More... | |
| enum class | GlgKeepEditRatio |
| Possible values of the KeepEditRatio attribute, used only by the GLG Editor when performing HierarchyDown. More... | |
| enum class | GlgLabelType |
| Provides a label type for a custom label formatter. More... | |
| enum class | GlgLayoutType |
| Specifies layout type. More... | |
| enum class | GlgLegendLayoutType |
| Specifies legend layout type. More... | |
| enum class | GlgLevelDrawOrder |
| Specifies a drawing order of a chart's Level Lines and Time Lines. More... | |
| enum class | GlgLevelType |
| Specifies a type of a chart's Level Line or a Time Line. More... | |
| enum class | GlgLightType |
| Specifies light type. More... | |
| enum class | GlgLineAnchoringType |
| Specifies line anchoring type for multi-line text objects. More... | |
| enum class | GlgLineAttrType |
| Specifies the type of a Line Attributes object. More... | |
| enum class | GlgLineCap |
| Specifies line cap style. More... | |
| enum class | GlgLogLevel |
| Specifies log level. More... | |
| enum class | GlgMarkerType |
| Specifies marker type binary flags that may be combined with bitwise OR. More... | |
| enum class | GlgMBType |
| Specifies the MB flag for fonts used in the C/C++ environment. More... | |
| enum class | GlgMediumType |
| Specifies the type of medium to load GLG object from. More... | |
| enum class | GlgModifierType |
| Modifier type. More... | |
| enum class | GlgMoveMode |
| Specifies the way an object is moved. More... | |
| enum class | GlgNativeTooltipType |
| Specifies the type of a tooltip to use. More... | |
| enum class | GlgObjectCoordSystem |
| Specifies types of an object's CoordFlag: the type of the coordinate system used to interpret point coordinates of an object. More... | |
| enum class | GlgObjectMatchType |
| Object matching criteria for the FindObjects method. More... | |
| enum class | GlgObjectType |
| GLG object types. More... | |
| enum class | GlgOffsetXformMoveFlag |
| Move Flag of the offset transformations. More... | |
| enum class | GlgOpenType |
| Specifies polygon open type. More... | |
| enum class | GlgOrientationType |
| Specifies orientation type. More... | |
| enum class | GlgPanType |
| Specifies the mode for a viewport's pan scrollbars. More... | |
| enum class | GlgParallType |
| Specifies parallelogram type. More... | |
| enum class | GlgPathRotationType |
| Specifies the rotation type of a path transformation. More... | |
| enum class | GlgPlotType |
| Specifies a type of a chart's plot. More... | |
| enum class | GlgPolygonShadingType |
| Specifies polygon shading type. More... | |
| enum class | GlgPositionModifier |
| Container position modifier. More... | |
| enum class | GlgPositionType |
| Container position type for the IsAt method. More... | |
| enum class | GlgProcessArmedType |
| Choices of the Action object's ProcessArmed attribute that controls processing of the Control key modifier. More... | |
| enum class | GlgProcessDoubleClickType |
| Choices of the Action object's ProcessArmed attribute that controls processing of the double-click. More... | |
| enum class | GlgProcessMouseMask |
| Specifies the type of the mouse events to be processed by a viewport. More... | |
| enum class | GlgProjectionType |
| Specifies map server GIS projection. More... | |
| enum class | GlgReferenceType |
| Specifies a type of a reference object. More... | |
| enum class | GlgRole |
| Specifies a role of an attribute object. More... | |
| enum class | GlgSampleQueryType |
| Data sample query type. More... | |
| enum class | GlgScaleAdjustmentType |
| Specifies scaling adjustment type for pixel offset and screen scaling transformations. More... | |
| enum class | GlgScalingType |
| Specifies scaling type for fixed size properties: text size, polygon line width, marker size, etc. More... | |
| enum class | GlgScrollbarType |
| Type of scrollbars to use for integrated panning. More... | |
| enum class | GlgSelectionEventType |
| Specifies the type of events returned by the CreateSelectionMessage method. More... | |
| enum class | GlgSelectionType |
| Specifies selection type. More... | |
| enum class | GlgShellType |
| Specifies viewport screen's shell type. More... | |
| enum class | GlgSplineType |
| Specifies spline type. More... | |
| enum class | GlgStorageType |
| Specifies template storage type of a reference object. More... | |
| enum class | GlgStretchType |
| Specifies stretch type of a viewport drawing. More... | |
| enum class | GlgTabNavigationType |
| Specifies the type of native components to traverse on a TAB press. More... | |
| enum class | GlgTagAccessType |
| Specifies tag access type. More... | |
| enum class | GlgTagType |
| Specifies tag type. More... | |
| enum class | GlgTextDirection |
| Specifies text direction. More... | |
| enum class | GlgTextType |
| Specifies text type. More... | |
| enum class | GlgTimeConversionType |
| Specifies time conversion type for the time format transformation. More... | |
| enum class | GlgTriggerType |
| Specifies a type of the mouse event that triggers an object's action. More... | |
| enum class | GlgUnitsType |
| Specifies the type of units that determine the size of the rounded corner of the Rounded object. More... | |
| enum class | GlgValueType |
| Provides value type for a custom label formatter. More... | |
| enum class | GlgWaveformType |
| Specifies timer transformation waveform type. More... | |
| enum class | GlgWidgetType |
| Specifies the native widget type used by the viewport screen object. More... | |
| enum class | GlgXFontType |
| Specifies the type of the X Windows font for the C/C++ environment. More... | |
| enum class | GlgXformType |
| Specifies transformation type. More... | |
| enum class | GlgZoomMode |
| Specifies zoom mode. More... | |
| enum class | GlgZoomState |
| Zoom state constants indicating the current Zoom operation in progress, if any. More... | |
| enum class | GlgZSortType |
| Specifies Z-sort type for hidden surface removal. More... | |
| enum class | GlmLabelSelectionMode |
| Specifies the label selection mode for a GIS object. More... | |
|
static |
Coordinate adjustement constant used to map the pixel index to the center of the pixel (i.e pixel #5 is mapped to coord=5.5).
|
static |
Equator radius in meters.
It is the lon extent of the GIS orthographic projection.
|
static |
A negative value for Z coordinates of converted points outside of the visible part of the globe in the GIS orthographic projection.
|
static |
Major version number.
|
static |
Minor version number.
|
static |
Polar radius in meters.
It is the lat extent of the GIS orthographic projection.
|
strong |
Container access type.
| Enumerator | |
|---|---|
| BOTTOM | Start from the bottom. |
| TOP | Start from the top. |
| CURRENT | Start from the current position. |
|
strong |
Specifies an action type.
|
strong |
Specifies anchoring type binary flags.
A bitwise OR combination of one horizontal and one vertical flag is used as a value of the Anchor attribute.
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
Choices of the armed_state parameter of the GetAction method that controls selection of the returned action object.
|
strong |
Arrow fill type constants.
The ArrowType attribute values are formed by combining GlgArrowPositionFlags and GlgArrowFillTypeFlags values with bitwise OR.
| Enumerator | |
|---|---|
| LINE_ATYPE | Arrow fill type constant. |
| FILL_ATYPE | Arrow fill type constant. |
| FILL_EDGE_ATYPE | Arrow fill type constant. |
|
strong |
Arrow position constants.
The ArrowType attribute values are formed by combining GlgArrowPositionFlags and GlgArrowFillTypeFlags values with bitwise OR.
|
strong |
Arrow position and fill type masks.
The masks are used to extract arrow position and fill type from the GlgArrowType values of the ArrowType attribute.
The result of applying a bitwise AND operator to the value of the ArrowType attribute and one of these masks extracts the arrow position (GlgArrowPositionFlags) or the arrow fill type (GlgArrowFillTypeFlags) values.
| Enumerator | |
|---|---|
| ARROW_POSITION_MASK | Extracts arrow position. |
| ARROW_TYPE_MASK | Extracts arrow fill type. |
|
strong |
Specifies arrow type.
See also GlgArrowPositionTypeMask, GlgArrowPositionFlags and GlgArrowFillTypeFlags.
|
strong |
Axis position and direction options.
The first element of each option (such as HTOP) specifies the axis' position, the second (such as UP) specifies the positive direction of the tick length.
|
strong |
Axis direction masks.
The masks are used to extract axis direction from the GlgAxisDirection values of the AxisDirection attribute.
The result of applying a bitwise AND operator to the value of the AxisDirection attribute and one of these masks indicates if the axis is vertical, or if the axis points in the positive or negative (inversed) direction.
| Enumerator | |
|---|---|
| POSITIVE_AXIS_MASK | Axis direction mask. |
| VERTICAL_AXIS_MASK | Axis direction mask. |
|
strong |
Binary flags used to form GlgAxisOutlineType elements by combining them via bitwise OR.
| Enumerator | |
|---|---|
| AXIS_ELEM | Draws axis line. |
| BOX_ELEM | Draw the outline's background. |
| MINOR_ELEM | Draws an outline around minor ticks. |
| MAJOR_ELEM | Draws an outline around major ticks. |
|
strong |
Axis outline type constants.
|
strong |
Specifies axis type.
|
strong |
Specifies conversion type for parameters of the boolean transformation.
|
strong |
Specifies the operation to be performed by the boolean transformation.
|
strong |
|
strong |
Specifies callback type.
See the Callback Events section of the Handling User Input and Other Events chapter of the GLG Programming Reference Manual for a description of callback functions.
| Enumerator | |
|---|---|
| INPUT_CB | Input callback. |
| SELECT_CB | Select callback. |
| TRACE_CB | Trace callback. |
| TRACE2_CB | Trace2 callback. |
| HIERARCHY_CB | Hierarchy callback. |
| TEMPLATE_LOAD_CB | Template load callback. |
|
strong |
Specifies the call event type for custom interaction handlers and installable interface handlers.
| Enumerator | |
|---|---|
| HI_SETUP_EVENT | Invoked on the initial setup of an interface handler. For interaction handlers, invoked before and after the hierarchy setup with different settings of the call_event flag. |
| HI_RESETUP_EVENT | Invoked only on re-setup of an interface handler. |
| CLEANUP_EVENT | Invoked on the handler reset. |
| MESSAGE_EVENT | Invoked to handle tokens sent to an interface handler , or to handle messages sent to an interaction handler by its children. |
| DI_SETUP_EVENT | Invoked on the drawing setup triggered by the change of the interaction handler's viewport or an object inside it. |
| CHANGE_EVENT | Triggered by a change of an object inside the interaction handler's viewport. |
| NATIVE_EVENT | Triggered by a native event received by the interaction handler's viewport. |
| MESSAGE_ACTION | Triggered by a message send to the interaction handler's viewport via the SendMessageToObject method. |
|
strong |
|
strong |
|
strong |
Controls drawing order of the chart's elements, may be combined with bitwise OR.
|
strong |
|
strong |
Specifies the interaction mode for the chart tooltip.
|
strong |
|
strong |
Specifies the comparison operator of the compare transformation.
|
strong |
Specifies compatibility mode.
|
strong |
Specifies a native component to return.
See GetNativeComponent for more information.
|
strong |
|
strong |
Specifies a type of objects to be held in a container object.
| Enumerator | |
|---|---|
| GLG_OBJECT | Drawable container with GlgObject elements. |
| STRING | String elements. |
| INT_VALUE | GlgInteger elements. |
| DBL_VALUE | GlgDouble elements. |
| NATIVE_OBJECT | Native object elements. |
| GLG_NON_DRAWABLE_OBJECT | Non-drawable container with GLG_OBJECT elements, is used for creating custom property groups. |
|
strong |
|
strong |
|
strong |
Specifies coordinate types for transforming objects.
|
strong |
|
strong |
Indicates when the custom setup handler is invoked.
|
strong |
|
strong |
|
strong |
Choices of the double_click_state parameter of the GetAction method that controls selection of the returned action object.
|
strong |
Specifies the type of a drawing's coordinate system that defines the drawing's resize policy (CoordSystem attribute of the viewport screen).
|
strong |
Controls existence and drawn order of the angular axis elements.
|
strong |
|
strong |
Specifies error message type for the Error method.
Internal errors are reserved for the Toolkit's use and are always processed by the GLG default error handler.
The rest of the error messages are processed by the currently installed error handler, or by the GLG default error handler if no custom error handlers were installed.
|
strong |
GLG event type constants.
|
strong |
|
strong |
|
strong |
Choices of filling extra space left by invisible elements in a square series.
Rows are vertical if ColumnsFirst=YES.
|
strong |
Specifies polygon fill type binary flags that may be combined with bitwise OR operator.
| Enumerator | |
|---|---|
| EDGE | Draw edge. |
| FILL | Draw fill. |
| FILL_EDGE | Convenience constant to draw fill and edge. |
| LINE_FILL | A flag used with EDGE to render the outer edges of thick lines using EdgeColor and the middle part using FillColor. |
| INVERSED_LINE_FILL | A flag that reverses colors when combined with LINE_FILL: thick lines will use EdgeColor for fill and FillColor for edges. |
| EDGE_LINE_FILL | Convenience constant to draw filled thick lines. |
| LINE_FILL_INV | Convenience constant to draw filled thick lines with inversed colors. |
|
strong |
|
strong |
Specifies the operation to be performed by the function transformation.
|
strong |
GIS request flags that control which parameters of the GIS object will be updated by the request.
|
strong |
GIS request status in request observer's RequestUpdate method.
| Enumerator | |
|---|---|
| GIS_ABORT_ON_GIS_CHANGE | Aborted due to GIS object parameters change. |
| GIS_ABORT_ON_NEW_REQUEST | Aborted due to new request being issued. |
| GIS_ABORT_OF_ZOOM_MODE | Aborted due to the abort of the ZoomTo request by the application. |
| GIS_ABORT_ON_LOAD_ERROR | Aborted due to the map image generation errors. |
| GIS_ABORT_ON_RESET | Aborted due to a reset of the GIS object. |
| GIS_ABORT_BY_API | Aborted by the AbortGISRequest API method. |
| GIS_REQUEST_READY | The GIS request is ready to be installed using InstallGISRequest. |
|
strong |
|
strong |
Specifies gradient type.
|
strong |
Specifies chart grid type.
|
strong |
Choices of handling invisible cells by a square series.
Rows are vertical if ColumnsFirst=YES.
|
strong |
Indicates when the hierarchy callback is invoked.
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
Specifies layout type.
|
strong |
|
strong |
Specifies a drawing order of a chart's Level Lines and Time Lines.
|
strong |
|
strong |
|
strong |
Specifies line anchoring type for multi-line text objects.
|
strong |
|
strong |
|
strong |
Specifies log level.
Each logging level also logs all messages above it with smaller log levels.
|
strong |
Specifies marker type binary flags that may be combined with bitwise OR.
|
strong |
|
strong |
|
strong |
|
strong |
Specifies the way an object is moved.
|
strong |
|
strong |
Specifies types of an object's CoordFlag: the type of the coordinate system used to interpret point coordinates of an object.
|
strong |
Object matching criteria for the FindObjects method.
|
strong |
GLG object types.
|
strong |
Move Flag of the offset transformations.
Specifies the way the offset transformation is changed when the point it is attached to is transformed.
| Enumerator | |
|---|---|
| CHANGE_OFFSETS | Change the transformation's offsets. |
| MOVE_ANCHOR_POINT | Move the transformation's anchor point. |
| MOVE_REFERENCE | For internal use by attachment points of reference objects. |
|
strong |
|
strong |
|
strong |
Specifies the mode for a viewport's pan scrollbars.
X and Y pan flags may be combined with bitwise OR to form the pan type.
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
Container position modifier.
Specifies how to adjust the current position for the next operation after performing the current one.
| Enumerator | |
|---|---|
| BEFORE | Adjust the current position to the previous element. |
| AFTER | Adjust the current position to the next element. |
|
strong |
Container position type for the IsAt method.
| Enumerator | |
|---|---|
| FIRST | At the first container element. |
| LAST | At the last container element. |
| START | Before the first container element. |
| END | After the last container element. |
|
strong |
Choices of the Action object's ProcessArmed attribute that controls processing of the Control key modifier.
|
strong |
Choices of the Action object's ProcessArmed attribute that controls processing of the double-click.
|
strong |
Specifies the type of the mouse events to be processed by a viewport.
The masks can be combined with bitwise OR.
|
strong |
|
strong |
|
strong |
Specifies a role of an attribute object.
| Enumerator | |
|---|---|
| GEOM_XR | Attribute role constant: control point. |
| COLOR_XR | Attribute role constant: color. |
| GDATA_XR | Attribute role constant: generic G "G" (XYZ or RGB) data. |
| DDATA_XR | Attribute role constant: generic D "D" (double) data. |
| SDATA_XR | Attribute role constant: generic S "S" (string) data. |
|
strong |
Data sample query type.
|
strong |
Specifies scaling adjustment type for pixel offset and screen scaling transformations.
|
strong |
|
strong |
|
strong |
Specifies the type of events returned by the CreateSelectionMessage method.
| Enumerator | |
|---|---|
| MOVE_SELECTION | Return MouseMove events. |
| CLICK_SELECTION | Return MouseClick events. |
| TOOLTIP_SELECTION | Return Tooltip events. |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
Specifies text type.
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
Specifies the native widget type used by the viewport screen object.
|
strong |
|
strong |
Specifies transformation type.
|
strong |
|
strong |
Zoom state constants indicating the current Zoom operation in progress, if any.
|
strong |
|
strong |
Specifies the label selection mode for a GIS object.