Options
All
  • Public
  • Public/Protected
  • All
Menu

geoview-core

Index

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

DatePrecision: "year" | "month" | "day"
LayerTypesKey: "ESRI_DYNAMIC" | "ESRI_FEATURE" | "GEOJSON" | "GEOCORE" | "XYZ_TILES" | "OGC_FEATURE" | "WFS" | "WMS"
Shape: { borderRadius: number | string; center: string; left: string; right: string }

Type declaration

  • borderRadius: number | string
  • center: string
  • left: string
  • right: string
TimePrecision: "hour" | "minute" | "second"
TypeActionButton: { children?: string | React.ReactElement | Element; id: string; title?: string; action?: any }

Type used to define an action button

Type declaration

TypeAppBarProps: { about: TypeLangString }

Type declaration

TypeAppVersion: { hash: string; major: number; minor: number; patch: number; timestamp: string }

An object containing version information.

export
interface

TypeAppVersion

Type declaration

  • hash: string
  • major: number
  • minor: number
  • patch: number
  • timestamp: string
TypeAttribution: { en-CA: string; fr-CA: string }

interface for attribution value

Type declaration

  • en-CA: string
  • fr-CA: string
TypeBaseWebLayersConfig: { id?: string; layerEntries?: (TypeDynamicLayerEntry | TypeOgcLayerEntry)[]; layerType: TypeWebLayers; name?: TypeLangString; url: TypeLangString }

interface used by all web layers

Type declaration

TypeBasemapLayer: { extent: Extent; id: string; jsonUrl?: string; maxScale: number; minScale: number; opacity: number; origin: number[]; resolutions: number[]; source: TypeBasemapLayerSource; type: string; url?: string }

interface used to define a new basemap layer

Type declaration

  • extent: Extent
  • id: string
  • Optional jsonUrl?: string
  • maxScale: number
  • minScale: number
  • opacity: number
  • origin: number[]
  • resolutions: number[]
  • source: TypeBasemapLayerSource
  • type: string
  • Optional url?: string
TypeBasemapLayerSource: OSM | XYZ
TypeBasemapOptions: { id: "transport" | "osm" | "simple" | "nogeom"; labeled: boolean; shaded: boolean }

interface for basemap options

Type declaration

  • id: "transport" | "osm" | "simple" | "nogeom"
  • labeled: boolean
  • shaded: boolean
TypeBasemapProps: { altText: string; attribution: string; defaultExtent?: Extent; defaultOrigin?: number[]; defaultResolutions?: number[]; descSummary: string; description: string; id?: string; layers: TypeBasemapLayer[]; name: string; thumbnailUrl: string | string[]; type: string; zoomLevels: TypeZoomLevels }

interface used to define a new basemap

Type declaration

  • altText: string
  • attribution: string
  • Optional defaultExtent?: Extent
  • Optional defaultOrigin?: number[]
  • Optional defaultResolutions?: number[]
  • descSummary: string
  • description: string
  • Optional id?: string
  • layers: TypeBasemapLayer[]
  • name: string
  • thumbnailUrl: string | string[]
  • type: string
  • zoomLevels: TypeZoomLevels
TypeButtonGroupProps: ButtonGroupProps

Button Group properties

TypeButtonPanel: { button: TypeIconButtonProps; groupName?: string; id: string; panel?: PanelApi }

Interface used when creating a new button panel

Type declaration

TypeButtonPanelProps: { button: TypeButtonProps; panel: TypePanelProps }

Interface used to initialize a button panel

Type declaration

TypeCGPV: { api: TypeApi; constants: TypeCGPVConstants; init: TypeCallback; react: typeof React; types: __module; ui: TypeCGPVUI; useTranslation: typeof useTranslation }

Type used for exporting core

Type declaration

TypeCGPVConstants: { options: TypeJsonObject }

Type used for exporting constants

Type declaration

TypeCGPVUI: { elements: typeof UI; makeStyles: typeof makeStyles; useMediaQuery: typeof useMediaQuery; useTheme: typeof useTheme }

Type used for exporting UI

Type declaration

  • elements: typeof UI
  • makeStyles: typeof makeStyles
  • useMediaQuery: typeof useMediaQuery
  • useTheme: typeof useTheme
TypeCallback: ((callback: (() => void)) => void)

Type declaration

    • (callback: (() => void)): void
    • Type used for a callback function

      Parameters

      • callback: (() => void)
          • (): void
          • Returns void

      Returns void

TypeChildren: React.ReactNode

Type used for react child nodes

TypeDetailsLayerSettings: { parser?: string; template: TypeLangString }

Type declaration

TypeDynamicLayerEntry: { index: number; name?: TypeLangString; nameField?: string; outfields?: string }

Type declaration

  • index: number
  • Optional name?: TypeLangString
  • Optional nameField?: string
  • Optional outfields?: string
TypeEntry: { attributes: TypeJsonObject }

Type declaration

TypeExternalPackages: { configUrl?: string; name: string }

Type declaration

  • Optional configUrl?: string
  • name: string
TypeFadeProps: FadeProps

Properties for the Fade element

TypeFeatureCircleStyle: { fillColor?: string; fillOpacity?: number; radius?: number; strokeColor?: string; strokeOpacity?: number; strokeWidth?: number }

Circle and Circle marker styles

Type declaration

  • Optional fillColor?: string
  • Optional fillOpacity?: number
  • Optional radius?: number
  • Optional strokeColor?: string
  • Optional strokeOpacity?: number
  • Optional strokeWidth?: number
TypeFeatureInfoProps: { buttonPanel: TypeButtonPanel; selectedFeature: TypeSelectedFeature; setPanel: any }

Feature info properties

Type declaration

TypeFeatureStyle: { fillColor?: string; fillOpacity?: number; strokeColor?: string; strokeOpacity?: number; strokeWidth?: number }

Line,Polygon,Marker styles

Type declaration

  • Optional fillColor?: string
  • Optional fillOpacity?: number
  • Optional strokeColor?: string
  • Optional strokeOpacity?: number
  • Optional strokeWidth?: number
TypeFeaturesListProps: { buttonPanel: TypeButtonPanel; selectedLayer: TypeLayersEntry | {}; getSymbol: any; selectFeature: any; selectLayer: any; setPanel: any }

Interface used for the Features List properties

Type declaration

TypeFieldAlias: {}

Type declaration

  • [name: string]: string
TypeFieldNameAliasArray: { alias: string; name: string }[]
TypeFilterFeatures: { fail: Feature[]; pass: Feature[] }

Type for return value for feature layer like GeoJSON, OGC API, Vector

Type declaration

  • fail: Feature[]
  • pass: Feature[]
TypeFilterQuery: { connector?: "&&" | "||"; field: string; operator: "===" | "!==" | "<=" | ">=" | "<" | ">"; value: string | number }

Type for building filter query

Type declaration

  • Optional connector?: "&&" | "||"
  • field: string
  • operator: "===" | "!==" | "<=" | ">=" | "<" | ">"
  • value: string | number
TypeFoundLayers: { entries: TypeEntry[]; layer: TypeLayersEntry }

Type declaration

TypeFunction: (() => void)

Type declaration

    • (): void
    • Type used for a function

      Returns void

TypeInteraction: "static" | "dynamic"
TypeJsonArray: TypeJsonValue & TypeJsonObject[]

Type used for an array of objects

TypeJsonObject: TypeJsonValue & {}

Type used for a json object

TypeJsonValue: null | string | number | boolean | TypeJsonObject[] | {}

Type used for a value within a json object

TypeLangString: { en: string; fr: string }

Type declaration

  • en: string
  • fr: string
TypeLanguages: "en" | "fr"
TypeLayerInfo: { displayField: string; displayFieldName: string; drawingInfo: { renderer: TypeRendererSymbol }; fields: TypeFieldNameAliasArray; id: string; name: string }

Type declaration

TypeLayerSettings: { boundingBox: boolean; opacity: number; query: boolean; visibility: boolean }

Type declaration

  • boundingBox: boolean
  • opacity: number
  • query: boolean
  • visibility: boolean
TypeLayersEntry: { displayField: string; entries?: TypeEntry[]; fieldAliases: TypeJsonValue; groupLayer: boolean; layer: TypeLayerInfo; layerData: TypeJsonArray; renderer: TypeRendererSymbol }

Type declaration

TypeLayersInWebLayer: Record<string, TypeLayersEntry>
TypeLayersListProps: { clickPos?: Coordinate; layersData: Record<string, AbstractWebLayersClass>; mapId: string; getSymbol: any; selectFeature: any; selectLayer: any }

interface for the layers list properties in details panel

Type declaration

TypeLayersPanelListProps: { language: string; layers: Record<string, AbstractWebLayersClass>; mapId: string }

interface for the layers list properties in layers panel

Type declaration

TypeLegendJsonDynamic: { extent: { spatialReference: { latestWkid: number; wkid: number }; xmax: number; xmin: number; ymax: number; ymin: number }; layerId: string; layerName: string; layerType: TypeWebLayers; legend: { contentType: string; height: number; imageData: string; label: string; url: string; width: number }[]; maxScale: number; minScale: number }

ESRI Json Legend for Dynamic Layer

Type declaration

  • extent: { spatialReference: { latestWkid: number; wkid: number }; xmax: number; xmin: number; ymax: number; ymin: number }
    • spatialReference: { latestWkid: number; wkid: number }
      • latestWkid: number
      • wkid: number
    • xmax: number
    • xmin: number
    • ymax: number
    • ymin: number
  • layerId: string
  • layerName: string
  • layerType: TypeWebLayers
  • legend: { contentType: string; height: number; imageData: string; label: string; url: string; width: number }[]
  • maxScale: number
  • minScale: number
TypeListItemProps: ListItemProps

List item properties

TypeLocalizedLanguages: "en-CA" | "fr-CA"
TypeMapComponents: "appbar" | "navbar" | "north-arrow" | "overview-map"
TypeMapConfig: { basemapOptions: TypeBasemapOptions; extraOptions?: Record<string, unknown>; interaction: TypeInteraction; layers?: TypeLayerConfig[]; view: TypeMapInitialView }

Type declaration

TypeMapContext: { id: string; interaction: string }

Type used for the map context

Type declaration

  • id: string
  • interaction: string
TypeMapControls: { boxZoom: boolean; selectBox: boolean }

Type declaration

  • boxZoom: boolean
  • selectBox: boolean
TypeMapCorePackages: "basemap-panel" | "layers-panel" | "details-panel" | "geolocator-panel"
TypeMapInitialView: { center: Coordinate; enableRotation?: boolean; extent?: Extent; maxZoom?: number; minZoom?: number; projection: number; rotation?: number; zoom: number }

Type declaration

  • center: Coordinate
  • Optional enableRotation?: boolean
  • Optional extent?: Extent
  • Optional maxZoom?: number
  • Optional minZoom?: number
  • projection: number
  • Optional rotation?: number
  • zoom: number
TypeMapSchemaProps: { appBar?: TypeAppBarProps; components?: TypeMapComponents[]; corePackages?: TypeMapCorePackages[]; externalPackages?: TypeExternalPackages[]; languages: TypeLocalizedLanguages[]; map: TypeMapConfig; navBar?: TypeNavBarProps[]; serviceUrls?: TypeServiceUrls; theme?: "dark" | "light"; version?: string }

Type declaration

TypeMapView: { center?: Coordinate; extent?: Extent; maxZoom: number; minZoom: number; projection?: ProjectionLike; resolution?: number; zoom: number }

Type used when setting map view

Type declaration

  • Optional center?: Coordinate
  • Optional extent?: Extent
  • maxZoom: number
  • minZoom: number
  • Optional projection?: ProjectionLike
  • Optional resolution?: number
  • zoom: number
TypeNavBarProps: "zoom" | "fullscreen" | "fullextent"
TypeNorthArrowProps: TypeJsonObject
TypeOfVector: "polyline" | "polygon" | "circle" | "circle_marker" | "marker"

interface used to define the vector types

TypeOgcLayerEntry: { id: string; name?: TypeLangString; state?: TypeLayerSettings }

Type declaration

TypePanelAppProps: { button: TypeIconButtonProps; panel: PanelApi }

Interface for panel properties

Type declaration

TypePanelContentProps: { buttonPanel: TypeButtonPanel; mapId: string }

Interface used for the panel content

Type declaration

TypePanelProps: { content?: React.ReactNode | Element; icon: React.ReactNode | Element; id?: string; status?: boolean; title: string | TypeJsonValue; type?: string; width: string | number }

type for the panel properties used when creating a new panel

Type declaration

  • Optional content?: React.ReactNode | Element
  • icon: React.ReactNode | Element
  • Optional id?: string
  • Optional status?: boolean
  • title: string | TypeJsonValue
  • Optional type?: string
  • width: string | number
TypePluginOptions: { mapId: string }

interface used by all plugins to define their options

Type declaration

  • mapId: string
TypePluginStructure: { api: API; configObj: TypeJsonObject; createElement: typeof React.createElement; id: string; makeStyles: typeof makeStyles; props: TypeJsonValue; react: typeof React; translate: TypeJsonValue; translations: TypeJsonObject; added?: any; defaultConfig?: any; removed?: any; schema?: any }

interface used when creating the actual plugin

Type declaration

TypeProjectionCodes: 3978 | 3857
TypeRecordOfPlugin: {}

Type declaration

TypeRendererSymbol: { field1: string; field2: string; field3: string; symbol: { contentType: string; label: string; legendImageUrl: string; type: "simple" | "uniqueValue" }; uniqueValueInfos: TypeJsonArray }

Type declaration

  • field1: string
  • field2: string
  • field3: string
  • symbol: { contentType: string; label: string; legendImageUrl: string; type: "simple" | "uniqueValue" }
    • contentType: string
    • label: string
    • legendImageUrl: string
    • type: "simple" | "uniqueValue"
  • uniqueValueInfos: TypeJsonArray
TypeSchemaObject: AnySchemaObject

Type used for the core schema

TypeSelectChangeEvent<unkown>: SelectChangeEvent<unkown>

Type Parameters

  • unkown

TypeSelectedFeature: { attributes: TypeJsonObject; displayField: TypeJsonObject; fieldAliases: TypeJsonObject; numOfEntries: number; symbol: TypeJsonObject }

Type declaration

TypeServiceUrls: { keys: string; proxyUrl?: string }

Type declaration

  • keys: string
  • Optional proxyUrl?: string
TypeSnackbarMessage: { params?: TypeJsonArray; type: string; value: string }

Interface used to initialize a snackbar message

Type declaration

TypeSwitchProps: SwitchProps & { mapId?: string }

Custom Material UI Switch properties

TypeTextFieldProps: TextFieldProps & { mapId?: string }

Custom Material UI Textfield properties

TypeUpdateScaleEvent: { distance: string; pixels: number }

Update scale event properties

Type declaration

  • distance: string
  • pixels: number
TypeVectorKeys: "POLYLINE" | "POLYGON" | "CIRCLE" | "CIRCLE_MARKER" | "MARKER"

interface used to define the vector type keys

TypeWebLayers: "esriDynamic" | "esriFeature" | "geojson" | "geoCore" | "xyzTiles" | "ogcFeature" | "ogcWfs" | "ogcWms"

interface used to define the web-layers

TypeZoomLevels: { max: number; min: number }

interface used to define zoom levels for a basemap

Type declaration

  • max: number
  • min: number

Variables

CONST_LAYER_TYPES: Record<LayerTypesKey, TypeWebLayers> = ...

constant contains layer types

CONST_PANEL_TYPES: { APPBAR: string; NAVBAR: string } = ...

constant that defines the panel types

Type declaration

  • APPBAR: string
  • NAVBAR: string
CONST_VECTOR_TYPES: Record<TypeVectorKeys, TypeOfVector> = ...

constant used to specify available vectors to draw

DEFAULT_DATE_PRECISION: { day: string; month: string; year: string } = ...

constant/interface used to define the precision for date object (yyyy, mm, dd)

Type declaration

  • day: string
  • month: string
  • year: string
DEFAULT_LAYER_NAMES: Record<TypeWebLayers, string> = ...

constant contains default layer names

DEFAULT_TIME_PRECISION: { hour: string; minute: string; second: string } = ...

constant/interface used to define the precision for time object (hh, mm, ss)

Type declaration

  • hour: string
  • minute: string
  • second: string
FILTER_OPERATOR: {} = ...

Type declaration

  • [key: string]: ((a: string | number, b: string | number) => boolean)
      • (a: string | number, b: string | number): boolean
      • Parameters

        • a: string | number
        • b: string | number

        Returns boolean

api: API = ...
cgpv: TypeCGPV = ...

Functions

  • Cast<TargetType>(p: unknown): TargetType
  • booleanPayload(event: EventStringId, handlerName: null | string, status: boolean): BooleanPayload
  • Helper function used to instanciate a BooleanPayload object. This function avoids the "new BooleanPayload" syntax.

    Parameters

    • event: EventStringId

      the event identifier for which the payload is constructed

    • handlerName: null | string

      the handler Name

    • status: boolean

      the boolean value carried by the payload

    Returns BooleanPayload

    the BooleanPayload object created

  • Helper function used to instanciate a ButtonPanelPayload object. This function avoids the "new ButtonPanelPayload" syntax.

    Parameters

    • event: EventStringId

      the event identifier for which the payload is constructed

    • handlerName: null | string

      the handler Name

    • id: string

      the the appbar panel identifier carried by the payload

    • groupName: string

      the the appbar panel group name carried by the payload

    • buttonPanel: TypeButtonPanel

      optional button panel configuration carried by the payload

    Returns ButtonPanelPayload

    the ButtonPanelPayload object created

  • inKeyfocusPayload(event: EventStringId, handlerName: null | string): InKeyfocusPayload
  • lngLatPayload(event: EventStringId, handlerName: null | string, lnglat: Coordinate): LngLatPayload
  • Helper function used to instanciate a LngLatPayload object. This function avoids the "new LngLatPayload" syntax.

    Parameters

    • event: EventStringId

      the event identifier for which the payload is constructed

    • handlerName: null | string

      the handler Name

    • lnglat: Coordinate

      the long lat values carried by the payload

    Returns LngLatPayload

    the LngLatPayload object created

  • mapComponentPayload(event: EventStringId, handlerName: null | string, id: string, component?: Element): MapComponentPayload
  • Helper function used to instanciate a MapComponentPayload object. This function avoids the "new MapComponentPayload" syntax.

    Parameters

    • event: EventStringId

      the event identifier for which the payload is constructed

    • handlerName: null | string

      the handler Name

    • id: string

      the map component identifier

    • Optional component: Element

      the map component element

    Returns MapComponentPayload

    the MapComponentPayload object created

  • mapPayload(event: EventStringId, handlerName: null | string, map: Map): MapPayload
  • Helper function used to instanciate a MapPayload object. This function avoids the "new MapPayload" syntax.

    Parameters

    • event: EventStringId

      the event identifier for which the payload is constructed

    • handlerName: null | string

      the handler Name

    • map: Map

      the map payload

    Returns MapPayload

    the MapPayload object created

  • mapViewProjectionPayload(event: EventStringId, handlerName: null | string, projection: number): MapViewProjectionPayload
  • modalPayload(event: EventStringId, handlerName: null | string, id: string, open?: boolean): ModalPayload
  • Helper function used to instanciate a ModalPayload object. This function avoids the "new ModalPayload" syntax.

    Parameters

    • event: EventStringId

      the event identifier for which the payload is constructed

    • handlerName: null | string

      the handler Name

    • id: string

      the modal identifier

    • Optional open: boolean

      optional flag used to specify if the modal is open

    Returns ModalPayload

    the ModalPayload object created

  • numberPayload(event: EventStringId, handlerName: null | string, value: number): NumberPayload
  • Helper function used to instanciate a NumberPayload object. This function avoids the "new NumberPayload" syntax.

    Parameters

    • event: EventStringId

      the event identifier for which the payload is constructed

    • handlerName: null | string

      the handler Name

    • value: number

      the value of the number carried by the payload

    Returns NumberPayload

    the NumberPayload object created

  • panelPayload(event: EventStringId, handlerName: null | string): PanelPayload
  • payloadBaseClass(event: EventStringId, handlerName: null | string): PayloadBaseClass
  • Type Gard function that redefines a PayloadBaseClass as a CirclePayload if the type attribute of the verifyIfPayload parameter is valid. The type ascention applies only to the the true block of the if clause.

    Parameters

    • verifyIfPayload: PayloadBaseClass

      object to test in order to determine if the type ascention is valid

    Returns verifyIfPayload is CirclePayload

    returns true of the payload is valid

  • Type Gard function that redefines a PayloadBaseClass as a MapPayload if the event attribute of the verifyIfPayload parameter is valid. The type ascention applies only to the the true block of the if clause.

    Parameters

    • verifyIfPayload: PayloadBaseClass

      object to test in order to determine if the type ascention is valid

    Returns verifyIfPayload is MapPayload

    returns true of the payload is valid

  • Type Gard function that redefines a PayloadBaseClass as a MarkerPayload if the type attribute of the verifyIfPayload parameter is valid. The type ascention applies only to the the true block of the if clause.

    Parameters

    • verifyIfPayload: PayloadBaseClass

      object to test in order to determine if the type ascention is valid

    Returns verifyIfPayload is MarkerPayload

    returns true of the payload is valid

  • Type Gard function that redefines a PayloadBaseClass as a ModalPayload if the event attribute of the verifyIfPayload parameter is valid. The type ascention applies only to the the true block of the if clause.

    Parameters

    • verifyIfPayload: PayloadBaseClass

      object to test in order to determine if the type ascention is valid

    Returns verifyIfPayload is ModalPayload

    returns true of the payload is valid

  • Type Gard function that redefines a PayloadBaseClass as a NumberPayload if the event attribute of the verifyIfPayload parameter is valid. The type ascention applies only to the the true block of the if clause.

    Parameters

    • verifyIfPayload: PayloadBaseClass

      object to test in order to determine if the type ascention is valid

    Returns verifyIfPayload is NumberPayload

    returns true of the payload is valid

  • Type Gard function that redefines a PayloadBaseClass as a PanelPayload if the event attribute of the verifyIfPayload parameter is valid. The type ascention applies only to the the true block of the if clause.

    Parameters

    • verifyIfPayload: PayloadBaseClass

      object to test in order to determine if the type ascention is valid

    Returns verifyIfPayload is PanelPayload

    returns true of the payload is valid

  • Type Gard function that redefines a PayloadBaseClass as a SliderPayload if the event attribute of the verifyIfPayload parameter is valid. The type ascention applies only to the the true block of the if clause.

    Parameters

    • verifyIfPayload: PayloadBaseClass

      object to test in order to determine if the type ascention is valid

    Returns verifyIfPayload is SliderPayload

    returns true of the payload is valid

  • Type Gard function that redefines a PayloadBaseClass as a VectorPayload if the event attribute of the verifyIfPayload parameter is valid. The type ascention applies only to the the true block of the if clause.

    Parameters

    • verifyIfPayload: PayloadBaseClass

      object to test in order to determine if the type ascention is valid

    Returns verifyIfPayload is VectorPayload

    returns true of the payload is valid

  • Helper function used to instanciate a VectorConfigPayload object. This function avoids the "new VectorConfigPayload" syntax.

    Parameters

    • event: EventStringId

      the event identifier for which the payload is constructed

    • handlerName: null | string

      the handler Name

    • type: TypeOfVector

      the type of vector configuration object that makes up the payload

    • Optional id: string

      the vector object identifier

    Returns VectorConfigPayload

    the VectorConfigPayload object created

Generated using TypeDoc