Class GARSProperties

GARS property loader

Hierarchy

GridProperties
- GARSProperties

Index

Constructors

Properties

Methods

buildProperty getBooleanProperty getDoubleProperty getFloatProperty getIntegerProperty getProperty getInstance

Constructors

constructor

new GARSProperties(config: any): GARSProperties
Parameters
- config: any
Returns GARSProperties
Inherited from GridProperties.constructor
- Defined in node_modules/@ngageoint/grid-js/dist/lib/property/GridProperties.d.ts:6

Properties

`Static` instance

instance: GARSProperties = ...

Singleton instance

Methods

buildProperty

buildProperty(properties: string[]): string
Build a combined property separated by PropertyConstants#PROPERTY_DIVIDER

Returns
combined property
Parameters
- properties: string[]
  
  property parts
Returns string
Inherited from GridProperties.buildProperty
- Defined in node_modules/@ngageoint/grid-js/dist/lib/property/GridProperties.d.ts:66

getBooleanProperty

getBooleanProperty(required?: boolean, ...key: string[]): undefined | boolean
Get a boolean by key

Returns
boolean value
Parameters
- Optional required: boolean
  
  true if required
- Rest ...key: string[]
  
  key
Returns undefined | boolean
Inherited from GridProperties.getBooleanProperty
- Defined in node_modules/@ngageoint/grid-js/dist/lib/property/GridProperties.d.ts:56

getDoubleProperty

getDoubleProperty(required?: boolean, ...key: string[]): undefined | number
Get a double by key

Returns
double value
Parameters
- Optional required: boolean
  
  true if required
- Rest ...key: string[]
  
  key
Returns undefined | number
Inherited from GridProperties.getDoubleProperty
- Defined in node_modules/@ngageoint/grid-js/dist/lib/property/GridProperties.d.ts:46

getFloatProperty

getFloatProperty(required?: boolean, ...key: string[]): undefined | number
Get a float by key

Returns
float value
Parameters
- Optional required: boolean
  
  true if required
- Rest ...key: string[]
  
  key
Returns undefined | number
Inherited from GridProperties.getFloatProperty
- Defined in node_modules/@ngageoint/grid-js/dist/lib/property/GridProperties.d.ts:36

getIntegerProperty

getIntegerProperty(required?: boolean, ...key: string[]): undefined | number
Get an integer property by key

Returns
integer value
Parameters
- Optional required: boolean
  
  true if required
- Rest ...key: string[]
  
  key
Returns undefined | number
Inherited from GridProperties.getIntegerProperty
- Defined in node_modules/@ngageoint/grid-js/dist/lib/property/GridProperties.d.ts:26

getProperty

getProperty(required: undefined | boolean, key: string): undefined | string
Get a property by key

Returns
value
Parameters
- required: undefined | boolean
  
  true if required
- key: string
  
  key
Returns undefined | string
Inherited from GridProperties.getProperty
- Defined in node_modules/@ngageoint/grid-js/dist/lib/property/GridProperties.d.ts:16

`Static` getInstance

getInstance(): GARSProperties
Get the singleton instance

Returns
instance

Returns GARSProperties
- Defined in lib/property/GARSProperties.ts:20

Generated using TypeDoc