Class IconTable

Icon Requirements Class Media Table

Hierarchy

MediaTable
- IconTable

Index

Constructors

Constructors

constructor

new IconTable(table?: UserCustomTable): IconTable
Constructor
Parameters
- Optional table: UserCustomTable
  
  attributes table
Returns IconTable
Overrides MediaTable.constructor
- Defined in lib/extension/nga/style/iconTable.ts:23

Properties

columns

columns: UserColumns<UserCustomColumn>

Columns

constraints

constraints: Constraints = ...

Constraints

contents: Contents

Foreign key to Contents

`Static` `Readonly` COLUMN_ANCHOR_U

COLUMN_ANCHOR_U: "anchor_u" = 'anchor_u'

`Static` `Readonly` COLUMN_ANCHOR_V

COLUMN_ANCHOR_V: "anchor_v" = 'anchor_v'

`Static` `Readonly` COLUMN_CONTENT_TYPE

COLUMN_CONTENT_TYPE: "content_type" = 'content_type'

Mime-type of data column name

`Static` `Readonly` COLUMN_DATA

COLUMN_DATA: "data" = 'data'

Multimedia content column name

`Static` `Readonly` COLUMN_DESCRIPTION

COLUMN_DESCRIPTION: "description" = 'description'

`Static` `Readonly` COLUMN_HEIGHT

COLUMN_HEIGHT: "height" = 'height'

`Static` `Readonly` COLUMN_NAME

COLUMN_NAME: "name" = 'name'

`Static` `Readonly` COLUMN_WIDTH

COLUMN_WIDTH: "width" = '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` RELATION_TYPE

RELATION_TYPE: RelationType = RelationType.MEDIA

User-Defined Media Table relation name

`Static` `Readonly` TABLE_NAME

TABLE_NAME: "nga_icon" = 'nga_icon'

Accessors

tableType

get tableType(): string
Get the table type

Returns string
Inherited from MediaTable.tableType
- Defined in lib/extension/related/userRelatedTable.ts:116

Methods

addColumn

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

addConstraint

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

addConstraints

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

addConstraintsWithConstraints

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

alterColumn

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

clearConstraints

clearConstraints(): Constraint[]
Clear the constraints

Returns
cleared constraints

Returns Constraint[]
Inherited from MediaTable.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 MediaTable.clearConstraintsByType
- Defined in lib/user/userTable.ts:353

columnCount

columnCount(): number
Get the column count

Returns
column count

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

columnsOfType

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

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

copy

copy(): UserCustomTable
Copy the UserCustomTable

Returns

Returns UserCustomTable
Inherited from MediaTable.copy
- Defined in lib/user/custom/userCustomTable.ts:76

createUserColumns

createUserColumns(columns: UserCustomColumn[]): UserColumns<UserCustomColumn>
Create user columns
Parameters
- columns: UserCustomColumn[]
Returns UserColumns<UserCustomColumn>
Inherited from MediaTable.createUserColumns
- Defined in lib/user/custom/userCustomTable.ts:68

createUserColumnsFromColumnNames

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

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

dropColumn

dropColumn(column: UserCustomColumn): void
Drop a column
Parameters
- column: UserCustomColumn
  
  column to drop
Returns void
Inherited from MediaTable.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 MediaTable.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 MediaTable.dropColumnWithName
- Defined in lib/user/userTable.ts:498

getAnchorUColumn

getAnchorUColumn(): UserColumn
Get the anchor_u column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/iconTable.ts:97

getAnchorUColumnIndex

getAnchorUColumnIndex(): number
Get the anchor_u column index

Returns
int

Returns number
- Defined in lib/extension/nga/style/iconTable.ts:90

getAnchorVColumn

getAnchorVColumn(): UserColumn
Get the anchor_v column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/iconTable.ts:111

getAnchorVColumnIndex

getAnchorVColumnIndex(): number
Get the anchor_v column index

Returns
int

Returns number
- Defined in lib/extension/nga/style/iconTable.ts:104

getColumn

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

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

getColumnForIndex

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

Returns
column
Parameters
- index: number
  
  column index
Returns UserCustomColumn
Inherited from MediaTable.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 MediaTable.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 MediaTable.getColumnName
- Defined in lib/user/userTable.ts:149

getColumnNames

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

Returns
column names

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

getColumns

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

Returns
columns

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

getColumnsForColumnNames

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

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

getConstraints

getConstraints(): Constraints
Get the constraints

Returns
constraints

Returns Constraints
Inherited from MediaTable.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 MediaTable.getConstraintsByType
- Defined in lib/user/userTable.ts:333

getContentTypeColumn

getContentTypeColumn(): UserCustomColumn
Get the content type column

Returns
content type column

Returns UserCustomColumn
Inherited from MediaTable.getContentTypeColumn
- Defined in lib/extension/related/media/mediaTable.ts:254

getContentTypeColumnIndex

getContentTypeColumnIndex(): number
Get the content type column index

Returns
content type column index

Returns number
Inherited from MediaTable.getContentTypeColumnIndex
- Defined in lib/extension/related/media/mediaTable.ts:245

getContents

getContents(): Contents
Get the contents

Returns
contents

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

getDataColumn

getDataColumn(): UserCustomColumn
Get the data column

Returns
data column

Returns UserCustomColumn
Inherited from MediaTable.getDataColumn
- Defined in lib/extension/related/media/mediaTable.ts:236

getDataColumnIndex

getDataColumnIndex(): number
Get the data column index

Returns
data column index

Returns number
Inherited from MediaTable.getDataColumnIndex
- Defined in lib/extension/related/media/mediaTable.ts:227

getDataType

getDataType(): string
Get the data type

Returns string
Inherited from MediaTable.getDataType
- Defined in lib/extension/related/userRelatedTable.ts:109

`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 MediaTable.getDataTypeOrDefault
- Defined in lib/user/userTable.ts:92

getDescriptionColumn

getDescriptionColumn(): UserColumn
Get the description column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/iconTable.ts:55

getDescriptionColumnIndex

getDescriptionColumnIndex(): number
Get the description column index

Returns
int

Returns number
- Defined in lib/extension/nga/style/iconTable.ts:48

getHeightColumn

getHeightColumn(): UserColumn
Get the height column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/iconTable.ts:83

getHeightColumnIndex

getHeightColumnIndex(): number
Get the height column index

Returns
int

Returns number
- Defined in lib/extension/nga/style/iconTable.ts:76

getIdColumn

getIdColumn(): UserCustomColumn
Get the id column

Returns
id column

Returns UserCustomColumn
Inherited from MediaTable.getIdColumn
- Defined in lib/extension/related/media/mediaTable.ts:218

getIdColumnIndex

getIdColumnIndex(): number
Get the id column index

Returns
id column index

Returns number
Inherited from MediaTable.getIdColumnIndex
- Defined in lib/extension/related/media/mediaTable.ts:209

getNameColumn

getNameColumn(): UserColumn
Get the name column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/iconTable.ts:41

getNameColumnIndex

getNameColumnIndex(): number
Get the name column index

Returns
int

Returns number
- Defined in lib/extension/nga/style/iconTable.ts:34

getPkColumn

getPkColumn(): UserCustomColumn
Get the primary key column

Returns
primary key column

Returns UserCustomColumn
Inherited from MediaTable.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 MediaTable.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 MediaTable.getPkColumnName
- Defined in lib/user/userTable.ts:263

getRelationName

getRelationName(): string
Get the relation name

Returns
relation name

Returns string
Inherited from MediaTable.getRelationName
- Defined in lib/extension/related/userRelatedTable.ts:102

getRequiredColumns

getRequiredColumns(): string[]
Get the required columns

Returns
required columns

Returns string[]
Inherited from MediaTable.getRequiredColumns
- Defined in lib/user/custom/userCustomTable.ts:108

getTableName

getTableName(): string
Get the table name

Returns
table name

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

getUserColumns

getUserColumns(): UserCustomColumns
Get user columns

Returns

Returns UserCustomColumns
Inherited from MediaTable.getUserColumns
- Defined in lib/user/custom/userCustomTable.ts:99

getWidthColumn

getWidthColumn(): UserColumn
Get the width column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/iconTable.ts:69

getWidthColumnIndex

getWidthColumnIndex(): number
Get the width column index

Returns
int

Returns number
- Defined in lib/extension/nga/style/iconTable.ts:62

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 MediaTable.hasColumn
- Defined in lib/user/userTable.ts:199

hasConstraints

hasConstraints(): boolean
Check if has constraints

Returns
true if has constraints

Returns boolean
Inherited from MediaTable.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 MediaTable.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 MediaTable.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 MediaTable.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 MediaTable.isValueValidation
- Defined in lib/user/userTable.ts:422

renameColumn

renameColumn(column: UserCustomColumn, newColumnName: string): void
Rename a column
Parameters
- column: UserCustomColumn
  
  column
- newColumnName: string
  
  new column name
Returns void
Inherited from MediaTable.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 MediaTable.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 MediaTable.renameColumnWithName
- Defined in lib/user/userTable.ts:466

setContents

setContents(contents: Contents): void
Set the contents
Parameters
- contents: Contents
  
  contents
Returns void
Inherited from MediaTable.setContents
- Defined in lib/user/userTable.ts:383

setPkModifiable

setPkModifiable(pkModifiable: boolean): void
Set if the primary key can be modified
Parameters
- pkModifiable: boolean
  
  primary key modifiable flag
Returns void
Inherited from MediaTable.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 MediaTable.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 MediaTable.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 MediaTable.validateContents
- Defined in lib/extension/related/userRelatedTable.ts:123

`Static` create

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

Returns

Returns IconTable
Overrides MediaTable.create
- Defined in lib/extension/nga/style/iconTable.ts:118

`Static` createColumns

createColumns(): UserColumn[]
Create the columns

Returns

Returns UserColumn[]
- Defined in lib/extension/nga/style/iconTable.ts:125

`Static` createContentTypeColumn

createContentTypeColumn(): UserCustomColumn
Create a content type column

Returns
content type column

Returns UserCustomColumn
Inherited from MediaTable.createContentTypeColumn
- Defined in lib/extension/related/media/mediaTable.ts:171

`Static` createContentTypeColumnWithIndex

createContentTypeColumnWithIndex(index?: number): UserCustomColumn
Create a content type column with a specified index

Returns
content type column
Parameters
- index: number = UserColumn.NO_INDEX
  
  column index
Returns UserCustomColumn
Inherited from MediaTable.createContentTypeColumnWithIndex
- Defined in lib/extension/related/media/mediaTable.ts:180

`Static` createDataColumn

createDataColumn(): UserCustomColumn
Create a data column

Returns
data column

Returns UserCustomColumn
Inherited from MediaTable.createDataColumn
- Defined in lib/extension/related/media/mediaTable.ts:154

`Static` createDataColumnWithIndex

createDataColumnWithIndex(index?: number): UserCustomColumn
Create a data column with a specified column index

Returns
data column
Parameters
- index: number = UserColumn.NO_INDEX
  
  column index
Returns UserCustomColumn
Inherited from MediaTable.createDataColumnWithIndex
- Defined in lib/extension/related/media/mediaTable.ts:163

`Static` createIdColumn

createIdColumn(idColumnName?: string, autoincrement?: boolean): UserCustomColumn
Create the primary key id column

Returns
id column
Parameters
- idColumnName: string = UserTableMetadataConstants.DEFAULT_ID_COLUMN_NAME
  
  id column name
- autoincrement: boolean = UserTable.DEFAULT_AUTOINCREMENT
  
  autoincrement id values
Returns UserCustomColumn
Inherited from MediaTable.createIdColumn
- Defined in lib/extension/related/media/mediaTable.ts:128

`Static` createIdColumnWithIndex

createIdColumnWithIndex(index?: number, idColumnName?: string, autoincrement?: boolean): UserCustomColumn
Create the primary key id column with a specified column index

Returns
id column
Parameters
- index: number = 0
  
  column index
- idColumnName: string = UserTableMetadataConstants.DEFAULT_ID_COLUMN_NAME
  
  id column name
- autoincrement: boolean = UserTable.DEFAULT_AUTOINCREMENT
  
  autoincrement id values
Returns UserCustomColumn
Inherited from MediaTable.createIdColumnWithIndex
- Defined in lib/extension/related/media/mediaTable.ts:142

`Static` createRequiredColumns

createRequiredColumns(idColumnName?: string, autoincrement?: boolean): UserCustomColumn[]
Create the required table columns with the id column name

Returns
user custom columns
Parameters
- Optional idColumnName: string
  
  id column name
- autoincrement: boolean = UserTable.DEFAULT_AUTOINCREMENT
  
  autoincrement id values
Returns UserCustomColumn[]
Inherited from MediaTable.createRequiredColumns
- Defined in lib/extension/related/media/mediaTable.ts:82

`Static` createRequiredColumnsWithStartingIndex

createRequiredColumnsWithStartingIndex(startingIndex?: number, idColumnName?: string, autoincrement?: boolean): UserCustomColumn[]
Create the required table columns with the id column name with a specified starting index

Returns
user custom columns
Parameters
- startingIndex: number = 0
  
  starting index
- Optional idColumnName: string
  
  id column name
- autoincrement: boolean = UserTable.DEFAULT_AUTOINCREMENT
  
  autoincrement id values
Returns UserCustomColumn[]
Inherited from MediaTable.createRequiredColumnsWithStartingIndex
- Defined in lib/extension/related/media/mediaTable.ts:105

`Static` numRequiredColumns

numRequiredColumns(): number
Get the number of required columns

Returns
required columns count

Returns number
Inherited from MediaTable.numRequiredColumns
- Defined in lib/extension/related/media/mediaTable.ts:189

`Static` requiredColumns

requiredColumns(idColumnName?: string): string[]
Get the required columns
Parameters
- idColumnName: string = UserTableMetadataConstants.DEFAULT_ID_COLUMN_NAME
Returns string[]
Inherited from MediaTable.requiredColumns
- Defined in lib/extension/related/media/mediaTable.ts:196

Class IconTable

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional table: UserCustomTable

Returns IconTable

Properties

columns

constraints

contents

Static Readonly COLUMN_ANCHOR_U

Static Readonly COLUMN_ANCHOR_V

Static Readonly COLUMN_CONTENT_TYPE

Static Readonly COLUMN_DATA

Static Readonly COLUMN_DESCRIPTION

Static Readonly COLUMN_HEIGHT

Static Readonly COLUMN_NAME

Static Readonly COLUMN_WIDTH

Static DEFAULT_AUTOINCREMENT

Static DEFAULT_PK_NOT_NULL

Static Readonly RELATION_TYPE

Static Readonly TABLE_NAME

Accessors

tableType

Returns string

Methods

addColumn

Parameters

column: UserCustomColumn

Returns void

addConstraint

Parameters

constraint: Constraint

Returns void

addConstraints

Parameters

constraints: Constraint[]

Returns void

addConstraintsWithConstraints

Parameters

constraints: Constraints

Returns void

alterColumn

Parameters

column: UserCustomColumn

Returns void

clearConstraints

Returns

Returns Constraint[]

clearConstraintsByType

Returns

Parameters

type: ConstraintType

Returns Constraint[]

columnCount

Returns

Returns number

columnsOfType

Returns

Parameters

type: GeoPackageDataType

Returns UserCustomColumn[]

copy

Returns

Returns UserCustomTable

createUserColumns

Parameters

columns: UserCustomColumn[]

Returns UserColumns<UserCustomColumn>

createUserColumnsFromColumnNames

Returns

Parameters

columnNames: string[]

Returns UserColumns<UserCustomColumn>

`Optional` table: UserCustomTable

`Static` `Readonly` COLUMN_ANCHOR_U

`Static` `Readonly` COLUMN_ANCHOR_V

`Static` `Readonly` COLUMN_CONTENT_TYPE

`Static` `Readonly` COLUMN_DATA

`Static` `Readonly` COLUMN_DESCRIPTION

`Static` `Readonly` COLUMN_HEIGHT

`Static` `Readonly` COLUMN_NAME

`Static` `Readonly` COLUMN_WIDTH

`Static` DEFAULT_AUTOINCREMENT

`Static` DEFAULT_PK_NOT_NULL

`Static` `Readonly` RELATION_TYPE

`Static` `Readonly` TABLE_NAME