Class StyleTable

StyleTable

Hierarchy

AttributesTable
- StyleTable

Index

Constructors

Properties

columns constraints contents data_type relation_name COLUMN_COLOR COLUMN_DESCRIPTION COLUMN_FILL_COLOR COLUMN_FILL_OPACITY COLUMN_ID COLUMN_NAME COLUMN_OPACITY COLUMN_WIDTH DEFAULT_AUTOINCREMENT DEFAULT_PK_NOT_NULL TABLE_NAME

Methods

addColumn addConstraint addConstraints addConstraintsWithConstraints alterColumn clearConstraints clearConstraintsByType columnCount columnsOfType copy createUserColumns createUserColumnsFromColumnNames dropColumn dropColumnWithIndex dropColumnWithName getColorColumn getColorColumnIndex getColumn getColumnForIndex getColumnIndex getColumnName getColumnNames getColumns getColumnsForColumnNames getConstraints getConstraintsByType getContents getDataType getDataTypeOrDefault getDescriptionColumn getDescriptionColumnIndex getFillColorColumn getFillColorColumnIndex getFillOpacityColumn getFillOpacityColumnIndex getNameColumn getNameColumnIndex getOpacityColumn getOpacityColumnIndex getPkColumn getPkColumnIndex getPkColumnName getTableName getUserColumns getWidthColumn getWidthColumnIndex hasColumn hasConstraints hasConstraintsForType hasPkColumn isPkModifiable isValueValidation renameColumn renameColumnWithIndex renameColumnWithName setContents setPkModifiable setTableName setValueValidation validateContents create createColumns

Constructors

constructor

new StyleTable(attributesTable?: AttributesTable): StyleTable
Constructor
Parameters
- Optional attributesTable: AttributesTable
  
  attributes table
Returns StyleTable
Overrides AttributesTable.constructor
- Defined in lib/extension/nga/style/styleTable.ts:27

Properties

columns

columns: UserColumns<AttributesColumn>

Columns

constraints

constraints: Constraints = ...

Constraints

contents: Contents

Foreign key to Contents

data_type

data_type: string = RelationType.ATTRIBUTES.dataType

relation_name

relation_name: string = RelationType.ATTRIBUTES.name

`Static` `Readonly` COLUMN_COLOR

COLUMN_COLOR: string = 'color'

`Static` `Readonly` COLUMN_DESCRIPTION

COLUMN_DESCRIPTION: string = 'description'

`Static` `Readonly` COLUMN_FILL_COLOR

COLUMN_FILL_COLOR: string = 'fill_color'

`Static` `Readonly` COLUMN_FILL_OPACITY

COLUMN_FILL_OPACITY: string = 'fill_opacity'

`Static` `Readonly` COLUMN_ID

COLUMN_ID: string = 'id'

`Static` `Readonly` COLUMN_NAME

COLUMN_NAME: string = 'name'

`Static` `Readonly` COLUMN_OPACITY

COLUMN_OPACITY: string = 'opacity'

`Static` `Readonly` COLUMN_WIDTH

COLUMN_WIDTH: string = 'width'

`Static` DEFAULT_AUTOINCREMENT

DEFAULT_AUTOINCREMENT: boolean = true

Default id autoincrement setting

`Static` DEFAULT_PK_NOT_NULL

DEFAULT_PK_NOT_NULL: boolean = true

Default primary key not null setting

`Static` `Readonly` TABLE_NAME

TABLE_NAME: string = 'nga_style'

Methods

addColumn

addColumn(column: AttributesColumn): void
Add a new column
Parameters
- column: AttributesColumn
  
  new column
Returns void
Inherited from AttributesTable.addColumn
- Defined in lib/user/userTable.ts:442

addConstraint

addConstraint(constraint: Constraint): void
Add constraint
Parameters
- constraint: Constraint
  
  constraint
Returns void
Inherited from AttributesTable.addConstraint
- Defined in lib/user/userTable.ts:273

addConstraints

addConstraints(constraints: Constraint[]): void
Add constraints
Parameters
- constraints: Constraint[]
  
  constraints
Returns void
Inherited from AttributesTable.addConstraints
- Defined in lib/user/userTable.ts:283

addConstraintsWithConstraints

addConstraintsWithConstraints(constraints: Constraints): void
Add constraints
Parameters
- constraints: Constraints
  
  constraints
Returns void
Inherited from AttributesTable.addConstraintsWithConstraints
- Defined in lib/user/userTable.ts:293

alterColumn

alterColumn(column: AttributesColumn): void
Alter a column
Parameters
- column: AttributesColumn
  
  altered column
Returns void
Inherited from AttributesTable.alterColumn
- Defined in lib/user/userTable.ts:518

clearConstraints

clearConstraints(): Constraint[]
Clear the constraints

Returns
cleared constraints

Returns Constraint[]
Inherited from AttributesTable.clearConstraints
- Defined in lib/user/userTable.ts:342

clearConstraintsByType

clearConstraintsByType(type: ConstraintType): Constraint[]
Clear the constraints of the provided type

Returns
cleared constraints
Parameters
- type: ConstraintType
  
  constraint type
Returns Constraint[]
Inherited from AttributesTable.clearConstraintsByType
- Defined in lib/user/userTable.ts:353

columnCount

columnCount(): number
Get the column count

Returns
column count

Returns number
Inherited from AttributesTable.columnCount
- Defined in lib/user/userTable.ts:208

columnsOfType

columnsOfType(type: GeoPackageDataType): AttributesColumn[]
Get the columns with the provided data type

Returns
columns
Parameters
- type: GeoPackageDataType
  
  data type
Returns AttributesColumn[]
Inherited from AttributesTable.columnsOfType
- Defined in lib/user/userTable.ts:364

copy

copy(): UserTable<AttributesColumn>
Copy the table

Returns
copied table

Returns UserTable<AttributesColumn>
Inherited from AttributesTable.copy
- Defined in lib/attributes/attributesTable.ts:33

createUserColumns

createUserColumns(columns: AttributesColumn[]): UserColumns<AttributesColumn>
Create user columns for a subset of table columns

Returns
user columns
Parameters
- columns: AttributesColumn[]
  
  columns
Returns UserColumns<AttributesColumn>
Inherited from AttributesTable.createUserColumns
- Defined in lib/attributes/attributesTable.ts:37

createUserColumnsFromColumnNames

createUserColumnsFromColumnNames(columnNames: string[]): UserColumns<AttributesColumn>
Create user columns for a subset of table columns

Returns
user columns
Parameters
- columnNames: string[]
  
  column names
Returns UserColumns<AttributesColumn>
Inherited from AttributesTable.createUserColumnsFromColumnNames
- Defined in lib/user/userTable.ts:115

dropColumn

dropColumn(column: AttributesColumn): void
Drop a column
Parameters
- column: AttributesColumn
  
  column to drop
Returns void
Inherited from AttributesTable.dropColumn
- Defined in lib/user/userTable.ts:488

dropColumnWithIndex

dropColumnWithIndex(index: number): void
Drop a column
Parameters
- index: number
  
  column index
Returns void
Inherited from AttributesTable.dropColumnWithIndex
- Defined in lib/user/userTable.ts:508

dropColumnWithName

dropColumnWithName(columnName: string): void
Drop a column
Parameters
- columnName: string
  
  column name
Returns void
Inherited from AttributesTable.dropColumnWithName
- Defined in lib/user/userTable.ts:498

getColorColumn

getColorColumn(): UserColumn
Get the color column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/styleTable.ts:73

getColorColumnIndex

getColorColumnIndex(): number
Get the color column index

Returns
int

Returns number
- Defined in lib/extension/nga/style/styleTable.ts:66

getColumn

getColumn(columnName: string): AttributesColumn
Get the column of the column name

Returns
column
Parameters
- columnName: string
  
  column name
Returns AttributesColumn
Inherited from AttributesTable.getColumn
- Defined in lib/user/userTable.ts:188

getColumnForIndex

getColumnForIndex(index: number): AttributesColumn
Get the column at the index

Returns
column
Parameters
- index: number
  
  column index
Returns AttributesColumn
Inherited from AttributesTable.getColumnForIndex
- Defined in lib/user/userTable.ts:179

getColumnIndex

getColumnIndex(columnName: string): number
Get the column index of the column name

Returns
column index
Parameters
- columnName: string
  
  column name
Returns number
Inherited from AttributesTable.getColumnIndex
- Defined in lib/user/userTable.ts:132

getColumnName

getColumnName(index: number): string
Get the column name at the index

Returns
column name
Parameters
- index: number
  
  column index
Returns string
Inherited from AttributesTable.getColumnName
- Defined in lib/user/userTable.ts:149

getColumnNames

getColumnNames(): string[]
Get the array of column names

Returns
column names

Returns string[]
Inherited from AttributesTable.getColumnNames
- Defined in lib/user/userTable.ts:140

getColumns

getColumns(): AttributesColumn[]
Get the list of columns

Returns
columns

Returns AttributesColumn[]
Inherited from AttributesTable.getColumns
- Defined in lib/user/userTable.ts:157

getColumnsForColumnNames

getColumnsForColumnNames(columnNames: string[]): AttributesColumn[]
Get the columns from the column names

Returns
columns
Parameters
- columnNames: string[]
  
  column names
Returns AttributesColumn[]
Inherited from AttributesTable.getColumnsForColumnNames
- Defined in lib/user/userTable.ts:166

getConstraints

getConstraints(): Constraints
Get the constraints

Returns
constraints

Returns Constraints
Inherited from AttributesTable.getConstraints
- Defined in lib/user/userTable.ts:322

getConstraintsByType

getConstraintsByType(type: ConstraintType): Constraint[]
Get the constraints of the provided type

Returns
constraints
Parameters
- type: ConstraintType
  
  constraint type
Returns Constraint[]
Inherited from AttributesTable.getConstraintsByType
- Defined in lib/user/userTable.ts:333

getContents

getContents(): Contents
Get the contents

Returns
contents

Returns Contents
Inherited from AttributesTable.getContents
- Defined in lib/user/userTable.ts:373

getDataType

getDataType(): string
Get the contents data type

Returns
data type

Returns string
Inherited from AttributesTable.getDataType
- Defined in lib/attributes/attributesTable.ts:41

`Protected` getDataTypeOrDefault

getDataTypeOrDefault(defaultType: string): string
Get the contents data type from the contents or use the default

Returns
contents or default data type
Parameters
- defaultType: string
  
  default data type
Returns string
Inherited from AttributesTable.getDataTypeOrDefault
- Defined in lib/user/userTable.ts:92

getDescriptionColumn

getDescriptionColumn(): UserColumn
Get the description column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/styleTable.ts:59

getDescriptionColumnIndex

getDescriptionColumnIndex(): number
Get the description column index

Returns
int

Returns number
- Defined in lib/extension/nga/style/styleTable.ts:52

getFillColorColumn

getFillColorColumn(): UserColumn
Get the fill_color column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/styleTable.ts:115

getFillColorColumnIndex

getFillColorColumnIndex(): number
Get the fill_color column index

Returns
int

Returns number
- Defined in lib/extension/nga/style/styleTable.ts:108

getFillOpacityColumn

getFillOpacityColumn(): UserColumn
Get the fill_opacity column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/styleTable.ts:129

getFillOpacityColumnIndex

getFillOpacityColumnIndex(): number
Get the fill_opacity column index

Returns
int

Returns number
- Defined in lib/extension/nga/style/styleTable.ts:122

getNameColumn

getNameColumn(): UserColumn
Get the name column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/styleTable.ts:45

getNameColumnIndex

getNameColumnIndex(): number
Get the name column index

Returns
int

Returns number
- Defined in lib/extension/nga/style/styleTable.ts:38

getOpacityColumn

getOpacityColumn(): UserColumn
Get the opacity column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/styleTable.ts:87

getOpacityColumnIndex

getOpacityColumnIndex(): number
Get the opacity column index

Returns
int

Returns number
- Defined in lib/extension/nga/style/styleTable.ts:80

getPkColumn

getPkColumn(): AttributesColumn
Get the primary key column

Returns
primary key column

Returns AttributesColumn
Inherited from AttributesTable.getPkColumn
- Defined in lib/user/userTable.ts:254

getPkColumnIndex

getPkColumnIndex(): number
Get the primary key column index

Returns
primary key column index

Returns number
Inherited from AttributesTable.getPkColumnIndex
- Defined in lib/user/userTable.ts:245

getPkColumnName

getPkColumnName(): string
Get the primary key column name

Returns
primary key column name

Returns string
Inherited from AttributesTable.getPkColumnName
- Defined in lib/user/userTable.ts:263

getTableName

getTableName(): string
Get the table name

Returns
table name

Returns string
Inherited from AttributesTable.getTableName
- Defined in lib/user/userTable.ts:217

getUserColumns

getUserColumns(): UserColumns<AttributesColumn>
Get the user columns

Returns
user columns

Returns UserColumns<AttributesColumn>
Inherited from AttributesTable.getUserColumns
- Defined in lib/user/userTable.ts:123

getWidthColumn

getWidthColumn(): UserColumn
Get the width column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/styleTable.ts:101

getWidthColumnIndex

getWidthColumnIndex(): number
Get the width column index

Returns
int

Returns number
- Defined in lib/extension/nga/style/styleTable.ts:94

hasColumn

hasColumn(columnName: string): boolean
Check if the table has the column

Returns
true if has the column
Parameters
- columnName: string
  
  column name
Returns boolean
Inherited from AttributesTable.hasColumn
- Defined in lib/user/userTable.ts:199

hasConstraints

hasConstraints(): boolean
Check if has constraints

Returns
true if has constraints

Returns boolean
Inherited from AttributesTable.hasConstraints
- Defined in lib/user/userTable.ts:302

hasConstraintsForType

hasConstraintsForType(type: ConstraintType): boolean
Check if has constraints of the provided type

Returns
true if has constraints
Parameters
- type: ConstraintType
  
  constraint type
Returns boolean
Inherited from AttributesTable.hasConstraintsForType
- Defined in lib/user/userTable.ts:313

hasPkColumn

hasPkColumn(): boolean
Check if the table has a primary key column

Returns
true if has a primary key

Returns boolean
Inherited from AttributesTable.hasPkColumn
- Defined in lib/user/userTable.ts:236

isPkModifiable

isPkModifiable(): boolean
Is the primary key modifiable

Returns
true if the primary key is modifiable

Returns boolean
Inherited from AttributesTable.isPkModifiable
- Defined in lib/user/userTable.ts:403

isValueValidation

isValueValidation(): boolean
Is value validation against column types enabled

Returns
true if values are validated against column types

Returns boolean
Inherited from AttributesTable.isValueValidation
- Defined in lib/user/userTable.ts:422

renameColumn

renameColumn(column: AttributesColumn, newColumnName: string): void
Rename a column
Parameters
- column: AttributesColumn
  
  column
- newColumnName: string
  
  new column name
Returns void
Inherited from AttributesTable.renameColumn
- Defined in lib/user/userTable.ts:454

renameColumnWithIndex

renameColumnWithIndex(index: number, newColumnName: string): void
Rename a column
Parameters
- index: number
  
  column index
- newColumnName: string
  
  new column name
Returns void
Inherited from AttributesTable.renameColumnWithIndex
- Defined in lib/user/userTable.ts:478

renameColumnWithName

renameColumnWithName(columnName: string, newColumnName: string): void
Rename a column
Parameters
- columnName: string
  
  column name
- newColumnName: string
  
  new column name
Returns void
Inherited from AttributesTable.renameColumnWithName
- Defined in lib/user/userTable.ts:466

setContents

setContents(contents: Contents): boolean
Set the contents
Parameters
- contents: Contents
  
  the contents
Returns boolean
Inherited from AttributesTable.setContents
- Defined in lib/attributes/attributesTable.ts:23

setPkModifiable

setPkModifiable(pkModifiable: boolean): void
Set if the primary key can be modified
Parameters
- pkModifiable: boolean
  
  primary key modifiable flag
Returns void
Inherited from AttributesTable.setPkModifiable
- Defined in lib/user/userTable.ts:413

setTableName

setTableName(tableName: string): void
Set the table name
Parameters
- tableName: string
  
  table name
Returns void
Inherited from AttributesTable.setTableName
- Defined in lib/user/userTable.ts:227

setValueValidation

setValueValidation(valueValidation: boolean): void
Set if values should validated against column types
Parameters
- valueValidation: boolean
  
  value validation flag
Returns void
Inherited from AttributesTable.setValueValidation
- Defined in lib/user/userTable.ts:432

`Protected` validateContents

validateContents(contents: Contents): void
Validate that the set contents are valid
Parameters
- contents: Contents
  
  contents
Returns void
Inherited from AttributesTable.validateContents
- Defined in lib/user/userTable.ts:396

`Static` create

create(): StyleTable
Create a media table with a minimum required columns followed by the additional columns

Returns

Returns StyleTable
- Defined in lib/extension/nga/style/styleTable.ts:136

`Static` createColumns

createColumns(): AttributesColumn[]
Create the columns

Returns

Returns AttributesColumn[]
- Defined in lib/extension/nga/style/styleTable.ts:143

Class StyleTable

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional attributesTable: AttributesTable

Returns StyleTable

Properties

columns

constraints

contents

data_type

relation_name

Static Readonly COLUMN_COLOR

Static Readonly COLUMN_DESCRIPTION

Static Readonly COLUMN_FILL_COLOR

Static Readonly COLUMN_FILL_OPACITY

Static Readonly COLUMN_ID

Static Readonly COLUMN_NAME

Static Readonly COLUMN_OPACITY

Static Readonly COLUMN_WIDTH

Static DEFAULT_AUTOINCREMENT

Static DEFAULT_PK_NOT_NULL

Static Readonly TABLE_NAME

Methods

addColumn

Parameters

column: AttributesColumn

Returns void

addConstraint

Parameters

constraint: Constraint

Returns void

addConstraints

Parameters

constraints: Constraint[]

Returns void

addConstraintsWithConstraints

Parameters

constraints: Constraints

Returns void

alterColumn

Parameters

column: AttributesColumn

Returns void

clearConstraints

Returns

Returns Constraint[]

clearConstraintsByType

Returns

Parameters

type: ConstraintType

Returns Constraint[]

columnCount

Returns

Returns number

columnsOfType

Returns

Parameters

type: GeoPackageDataType

Returns AttributesColumn[]

copy

Returns

Returns UserTable<AttributesColumn>

createUserColumns

Returns

Parameters

columns: AttributesColumn[]

Returns UserColumns<AttributesColumn>

createUserColumnsFromColumnNames

Returns

Parameters

columnNames: string[]

Returns UserColumns<AttributesColumn>

dropColumn

Parameters

`Optional` attributesTable: AttributesTable

`Static` `Readonly` COLUMN_COLOR

`Static` `Readonly` COLUMN_DESCRIPTION

`Static` `Readonly` COLUMN_FILL_COLOR

`Static` `Readonly` COLUMN_FILL_OPACITY

`Static` `Readonly` COLUMN_ID

`Static` `Readonly` COLUMN_NAME

`Static` `Readonly` COLUMN_OPACITY

`Static` `Readonly` COLUMN_WIDTH

`Static` DEFAULT_AUTOINCREMENT

`Static` DEFAULT_PK_NOT_NULL

`Static` `Readonly` TABLE_NAME

`Protected` getDataTypeOrDefault