Class DirectChat

Convert to and from an XML CoT message

Param: cot

A string/buffer containing the XML representation or the xml-js object tree

Hierarchy (View Summary)

default
- DirectChat

Constructors

constructor

new DirectChat(chat: DirectChatInput): DirectChat
Parameters
- chat: DirectChatInput
Returns DirectChat
Overrides default.constructor
- Defined in lib/chat.ts:26

Properties

metadata

metadata: Record<string, unknown>

path

path: string

raw

raw: {
    event: {
        _attributes: {
            access?: string;
            how?: string;
            opex?: string;
            qos?: string;
            stale: string;
            start: string;
            time: string;
            type: string;
            uid: string;
            version: string;
        };
        detail?: {
            __chat?: {
                _attributes: {
                    chatroom: string;
                    groupOwner?: string;
                    id: string;
                    messageId?: string;
                    parent?: string;
                    senderCallsign: string;
                };
                chatgrp: any;
            };
            __forcedelete?: {};
            __geofence?: {
                _attributes: {
                    boundingSphere?: number;
                    elevationMonitored?: string;
                    maxElevation?: string;
                    minElevation?: string;
                    monitor?: string;
                    tracking?: string;
                    trigger?: string;
                };
            };
            __group?: { _attributes?: { name: string; role: string } };
            __video?: {
                _attributes?: {
                    sensor?: string;
                    spi?: string;
                    uid?: string;
                    url?: string;
                };
                ConnectionEntry?: {
                    _attributes: {
                        address: string;
                        alias?: string;
                        bufferTime?: number;
                        ignoreEmbeddedKLV?: boolean;
                        networkTimeout?: number;
                        path?: string;
                        port?: number;
                        protocol?: string;
                        roverPort?: number;
                        rtspReliable?: number;
                        uid: string;
                    };
                };
            };
            "_flow-tags_"?: any;
            ackrequest?: {
                _attributes: { ackrequested: boolean; tag: string; uid: string };
            };
            archive?: | { _attributes?: { value?: string } }
            | { _attributes?: { value?: string } }[];
            attachment_list?: { _attributes: { hashes: string } };
            bearing?: { _attributes: { value: string } };
            bearingUnits?: { _attributes: { value: string } };
            color?: { _attributes?: { argb?: string } };
            contact?: {
                _attributes: {
                    callsign?: string;
                    endpoint?: string;
                    name?: string;
                    phone?: string;
                };
            };
            fileshare?: {
                _attributes: {
                    filename: string;
                    name: string;
                    senderCallsign: string;
                    senderUid: string;
                    senderUrl: string;
                    sha256: string;
                    sizeInBytes: number;
                };
            };
            fillColor?: { _attributes?: { value?: string } };
            inclination?: { _attributes: { value: string } };
            labels_on?: { _attributes?: { value?: string } };
            link?:
                | {
                    _attributes: {
                        mime?: string;
                        parent_callsign?: string;
                        point?: string;
                        production_time?: string;
                        relation?: string;
                        remarks?: string;
                        type?: string;
                        uid?: string;
                        url?: string;
                    };
                }
                | {
                    _attributes: {
                        mime?: string;
                        parent_callsign?: string;
                        point?: string;
                        production_time?: string;
                        relation?: string;
                        remarks?: string;
                        type?: string;
                        uid?: string;
                        url?: string;
                    };
                }[];
            link_attr?: {
                _attributes: {
                    color?: number;
                    direction?: "Infil"
                    | "Exfil";
                    method: "Driving" | "Walking" | "Flying" | "Swimming" | "Watercraft";
                    order: "Ascending Check Points" | "Descending Check Points";
                    planningmethod?: "Infil" | "Exfil";
                    prefix: string;
                    routetype: "Primary" | "Secondary";
                    stroke?: string;
                    type?: string;
                };
            };
            marti?: {
                _attributes?: {};
                dest?: | {
                    _attributes: {
                        after?: string;
                        callsign?: string;
                        mission?: string;
                        "mission-guid"?: string;
                        path?: string;
                        uid?: string;
                    };
                }
                | {
                    _attributes: {
                        after?: (...)
                        | (...);
                        callsign?: (...) | (...);
                        mission?: (...) | (...);
                        "mission-guid"?: (...) | (...);
                        path?: (...) | (...);
                        uid?: (...) | (...);
                    };
                }[];
            };
            mission?: {
                _attributes?: {
                    authorUid?: string;
                    guid?: string;
                    name?: string;
                    tool?: string;
                    type?: string;
                };
                MissionChanges?: {
                    MissionChange: | {
                        contentUid: { _text: ... };
                        creatorUid: { _text?: ... };
                        details: { _attributes: ...; location?: ... };
                        isFederatedChange: { _text: ... };
                        missionName: { _text: ... };
                        timestamp: { _text: ... };
                        type: { _text: ... };
                    }
                    | {
                        contentUid: ...;
                        creatorUid: ...;
                        details: ...;
                        isFederatedChange: ...;
                        missionName: ...;
                        timestamp: ...;
                        type: ...;
                    }[];
                };
                missionLayer?: {
                    name?: { _text: string };
                    parentUid?: { _text: string };
                    type?: { _text: string };
                    uid?: { _text: string };
                };
            };
            northRef?: { _attributes: { value: string } };
            precisionlocation?: {
                _attributes: { altsrc?: string; geopointsrc?: string };
            };
            range?: { _attributes: { value: string } };
            rangeUnits?: { _attributes: { value: string } };
            remarks?: {
                _attributes?: { source?: string; time?: string; to?: string };
                _text?: string;
            };
            sensor?: {
                _attributes: {
                    azimuth?: number;
                    displayMagneticReference?: number;
                    elevation?: number;
                    fov?: number;
                    fovAlpha?: number;
                    fovBlue?: number;
                    fovGreen?: number;
                    fovRed?: number;
                    hideFov?: boolean;
                    model?: string;
                    north?: number;
                    range?: number;
                    rangeLines?: number;
                    rangeLineStrokeColor?: number;
                    rangeLineStrokeWeight?: number;
                    roll?: number;
                    strokeColor?: number;
                    strokeWeight?: number;
                    type?: string;
                    version?: string;
                    vfov?: number;
                };
            };
            shape?: {
                ellipse?: {
                    _attributes: { angle: number; major: number; minor: number };
                };
                polyline?: {
                    _attributes?: {
                        closed?: (...)
                        | (...)
                        | (...);
                        color?: (...) | (...);
                        fillColor?: (...) | (...);
                    };
                    vertex?: | { _attributes: { lat: ...; lon: ... } }
                    | { _attributes: ... }[];
                };
            };
            status?: { _attributes: { battery?: string; readiness?: string } };
            strokeColor?: { _attributes?: { value?: string } };
            strokeStyle?: { _attributes?: { value?: string } };
            strokeWeight?: { _attributes?: { value?: string } };
            TakControl?: {
                TakProtocolSupport?: { _attributes?: { version?: (...) | (...) } };
                TakServerVersionInfo?: {
                    _attributes?: { serverVersion?: (...) | (...) };
                };
            };
            takv?: {
                _attributes: {
                    device?: string;
                    os?: string;
                    platform?: string;
                    version?: string;
                };
            };
            tog?: { _attributes?: { enabled?: string } };
            track?: {
                _attributes?: {
                    course?: string;
                    eCourse?: string;
                    eSlope?: string;
                    eSpeed?: string;
                    slope?: string;
                    speed?: string;
                };
            };
            uid?: { _attributes: { Droid: string } };
            usericon?: { _attributes: { iconsetpath: string } };
        };
        point: {
            _attributes: {
                ce: string
                | number;
                hae: string | number;
                lat: string | number;
                le: string | number;
                lon: string | number;
            };
        };
    };
}

Raw XML-JS representation of CoT

Methods

addDest

addDest(
    dest: {
        after?: string;
        callsign?: string;
        mission?: string;
        "mission-guid"?: string;
        path?: string;
        uid?: string;
    },
): default
Add a given Dest tag to a CoT
Parameters
- dest: {
      after?: string;
      callsign?: string;
      mission?: string;
      "mission-guid"?: string;
      path?: string;
      uid?: string;
  }
Returns default
Inherited from default.addDest
- Defined in lib/cot.ts:180

addLink

addLink(
    link: {
        mime?: string;
        parent_callsign?: string;
        point?: string;
        production_time?: string;
        relation?: string;
        remarks?: string;
        type?: string;
        uid?: string;
        url?: string;
    },
): default
Parameters
- link: {
      mime?: string;
      parent_callsign?: string;
      point?: string;
      production_time?: string;
      relation?: string;
      remarks?: string;
      type?: string;
      uid?: string;
      url?: string;
  }
Returns default
Inherited from default.addLink
- Defined in lib/cot.ts:275

addVideo

addVideo(
    video: { sensor?: string; spi?: string; uid?: string; url?: string },
    connection?: {
        address: string;
        alias?: string;
        bufferTime?: number;
        ignoreEmbeddedKLV?: boolean;
        networkTimeout?: number;
        path?: string;
        port?: number;
        protocol?: string;
        roverPort?: number;
        rtspReliable?: number;
        uid: string;
    },
): default
Parameters
- video: { sensor?: string; spi?: string; uid?: string; url?: string }
- Optionalconnection: {
      address: string;
      alias?: string;
      bufferTime?: number;
      ignoreEmbeddedKLV?: boolean;
      networkTimeout?: number;
      path?: string;
      port?: number;
      protocol?: string;
      roverPort?: number;
      rtspReliable?: number;
      uid: string;
  }
Returns default
Inherited from default.addVideo
- Defined in lib/cot.ts:198

callsign

callsign(callsign?: string): string
Returns or sets the Callsign of the CoT
Parameters
- Optionalcallsign: string
Returns string
Inherited from default.callsign
- Defined in lib/cot.ts:153

is_airborne

is_airborne(): boolean
Determines if the CoT message represents an Airborne Element

Returns boolean
Inherited from default.is_airborne
- Defined in lib/cot.ts:760

is_assumed

is_assumed(): boolean
Determines if the CoT message represents an Assumed Element

Returns boolean
Inherited from default.is_assumed
- Defined in lib/cot.ts:706

is_atom

is_atom(): boolean
Determines if the CoT message represents an Element

Returns boolean
Inherited from default.is_atom
- Defined in lib/cot.ts:751

is_chat

is_chat(): boolean
Determines if the CoT message represents a Chat Message

Returns boolean
Inherited from default.is_chat
- Defined in lib/cot.ts:661

is_equipment

is_equipment(): boolean
Determines if the CoT message represents Equipment

Returns boolean
Inherited from default.is_equipment
- Defined in lib/cot.ts:796

is_faker

is_faker(): boolean
Determines if the CoT message represents a Faker Element

Returns boolean
Inherited from default.is_faker
- Defined in lib/cot.ts:742

is_friend

is_friend(): boolean
Determines if the CoT message represents a Friendly Element

Returns boolean
Inherited from default.is_friend
- Defined in lib/cot.ts:670

is_ground

is_ground(): boolean
Determines if the CoT message represents a Ground Element

Returns boolean
Inherited from default.is_ground
- Defined in lib/cot.ts:769

is_hostile

is_hostile(): boolean
Determines if the CoT message represents a Hostile Element

Returns boolean
Inherited from default.is_hostile
- Defined in lib/cot.ts:679

is_installation

is_installation(): boolean
Determines if the CoT message represents an Installation

Returns boolean
Inherited from default.is_installation
- Defined in lib/cot.ts:778

is_joker

is_joker(): boolean
Determines if the CoT message represents a Joker Element

Returns boolean
Inherited from default.is_joker
- Defined in lib/cot.ts:733

is_neutral

is_neutral(): boolean
Determines if the CoT message represents a Neutral Element

Returns boolean
Inherited from default.is_neutral
- Defined in lib/cot.ts:715

is_pending

is_pending(): boolean
Determines if the CoT message represents a Pending Element

Returns boolean
Inherited from default.is_pending
- Defined in lib/cot.ts:697

is_subsurface

is_subsurface(): boolean
Determines if the CoT message represents a Subsurface Element

Returns boolean
Inherited from default.is_subsurface
- Defined in lib/cot.ts:814

is_surface

is_surface(): boolean
Determines if the CoT message represents a Surface Element

Returns boolean
Inherited from default.is_surface
- Defined in lib/cot.ts:805

is_suspect

is_suspect(): boolean
Determines if the CoT message represents a Suspect Element

Returns boolean
Inherited from default.is_suspect
- Defined in lib/cot.ts:724

is_tasking

is_tasking(): boolean
Determines if the CoT message represents a Tasking Message

Returns boolean
Inherited from default.is_tasking
- Defined in lib/cot.ts:652

is_uav

is_uav(): boolean
Determines if the CoT message represents a UAV Element

Returns boolean
Inherited from default.is_uav
- Defined in lib/cot.ts:823

is_unknown

is_unknown(): boolean
Determines if the CoT message represents a Unknown Element

Returns boolean
Inherited from default.is_unknown
- Defined in lib/cot.ts:688

is_vehicle

is_vehicle(): boolean
Determines if the CoT message represents a Vehicle

Returns boolean
Inherited from default.is_vehicle
- Defined in lib/cot.ts:787

isDiff

isDiff(
    cot: default,
    opts?: {
        diffDest: boolean;
        diffFlow: boolean;
        diffMetadata: boolean;
        diffStaleStartTime: boolean;
    },
): boolean
Detect difference between CoT messages Note: This diffs based on GeoJSON Representation of message So if unknown properties are present they will be excluded from the diff
Parameters
- cot: default
- opts: {
      diffDest: boolean;
      diffFlow: boolean;
      diffMetadata: boolean;
      diffStaleStartTime: boolean;
  } = ...
Returns boolean
Inherited from default.isDiff
- Defined in lib/cot.ts:109

position

position(position?: number[]): number[]
Parameters
- Optionalposition: number[]
Returns number[]
Inherited from default.position
- Defined in lib/cot.ts:244

sensor

sensor(
    sensor?: {
        azimuth?: number;
        displayMagneticReference?: number;
        elevation?: number;
        fov?: number;
        fovAlpha?: number;
        fovBlue?: number;
        fovGreen?: number;
        fovRed?: number;
        hideFov?: boolean;
        model?: string;
        north?: number;
        range?: number;
        rangeLines?: number;
        rangeLineStrokeColor?: number;
        rangeLineStrokeWeight?: number;
        roll?: number;
        strokeColor?: number;
        strokeWeight?: number;
        type?: string;
        version?: string;
        vfov?: number;
    },
): null
| { coordinates: number[][][]; type: "Polygon" }
Parameters
- Optionalsensor: {
      azimuth?: number;
      displayMagneticReference?: number;
      elevation?: number;
      fov?: number;
      fovAlpha?: number;
      fovBlue?: number;
      fovGreen?: number;
      fovRed?: number;
      hideFov?: boolean;
      model?: string;
      north?: number;
      range?: number;
      rangeLines?: number;
      rangeLineStrokeColor?: number;
      rangeLineStrokeWeight?: number;
      roll?: number;
      strokeColor?: number;
      strokeWeight?: number;
      type?: string;
      version?: string;
      vfov?: number;
  }
Returns null | { coordinates: number[][][]; type: "Polygon" }
Inherited from default.sensor
- Defined in lib/cot.ts:256

to_geojson

to_geojson(): {
    geometry: | { coordinates: number[][][]; type: "Polygon" }
    | { coordinates: number[]; type: "Point" }
    | { coordinates: number[][]; type: "LineString" };
    id: string;
    path?: string;
    properties: {
        ackrequest?: { ackrequested: boolean; tag: string; uid: string };
        archived?: boolean;
        attachments?: string[];
        callsign: string;
        center: number[];
        chat?: {
            chatgrp: any;
            chatroom: string;
            groupOwner?: string;
            id: string;
            messageId?: string;
            parent?: string;
            senderCallsign: string;
        };
        contact?: {
            callsign?: string;
            endpoint?: string;
            name?: string;
            phone?: string;
        };
        course?: number;
        dest?: | {
            after?: string;
            callsign?: string;
            mission?: string;
            "mission-guid"?: string;
            path?: string;
            uid?: string;
        }
        | {
            after?: string;
            callsign?: string;
            mission?: string;
            "mission-guid"?: string;
            path?: string;
            uid?: string;
        }[];
        droid?: string;
        fileshare?: {
            filename: string;
            name: string;
            senderCallsign: string;
            senderUid: string;
            senderUrl: string;
            sha256: string;
            sizeInBytes: number;
        };
        fill?: string;
        "fill-opacity"?: number;
        flow?: { [key: string]: string };
        geofence?: {
            boundingSphere?: number;
            elevationMonitored?: string;
            maxElevation?: string;
            minElevation?: string;
            monitor?: string;
            tracking?: string;
            trigger?: string;
        };
        group?: { name: string; role: string };
        how: string;
        icon?: string;
        links?: {
            mime?: string;
            parent_callsign?: string;
            point?: string;
            production_time?: string;
            relation?: string;
            remarks?: string;
            type?: string;
            uid?: string;
            url?: string;
        }[];
        "marker-color"?: string;
        "marker-opacity"?: number;
        metadata?: { [key: string]: unknown };
        mission?: {
            authorUid?: string;
            guid?: string;
            missionChanges?: {
                contentUid: string;
                creatorUid: string;
                details: {
                    callsign: string;
                    color: string;
                    lat: string;
                    lon: string;
                    type: string;
                };
                isFederatedChange: string;
                missionName: string;
                timestamp: string;
                type: string;
            }[];
            missionLayer?: {
                name?: string;
                parentUid?: string;
                type?: string;
                uid?: string;
            };
            name?: string;
            tool?: string;
            type?: string;
        };
        precisionlocation?: { altsrc?: string; geopointsrc?: string };
        remarks?: string;
        sensor?: {
            azimuth?: number;
            displayMagneticReference?: number;
            elevation?: number;
            fov?: number;
            fovAlpha?: number;
            fovBlue?: number;
            fovGreen?: number;
            fovRed?: number;
            hideFov?: boolean;
            model?: string;
            north?: number;
            range?: number;
            rangeLines?: number;
            rangeLineStrokeColor?: number;
            rangeLineStrokeWeight?: number;
            roll?: number;
            strokeColor?: number;
            strokeWeight?: number;
            type?: string;
            version?: string;
            vfov?: number;
        };
        shape?: { ellipse?: { angle: number; major: number; minor: number } };
        slope?: number;
        speed?: number;
        stale: string;
        start: string;
        status?: { battery?: string; readiness?: string };
        stroke?: string;
        "stroke-opacity"?: number;
        "stroke-style"?: string;
        "stroke-width"?: number;
        takv?: {
            device?: string;
            os?: string;
            platform?: string;
            version?: string;
        };
        time: string;
        track?: {
            course?: string;
            eCourse?: string;
            eSlope?: string;
            eSpeed?: string;
            slope?: string;
            speed?: string;
        };
        type: string;
        video?: {
            connection?: {
                address: string;
                alias?: string;
                bufferTime?: number;
                ignoreEmbeddedKLV?: boolean;
                networkTimeout?: number;
                path?: string;
                port?: number;
                protocol?: string;
                roverPort?: number;
                rtspReliable?: number;
                uid: string;
            };
            sensor?: string;
            spi?: string;
            uid?: string;
            url?: string;
        };
    };
    type: string;
}
Return a GeoJSON Feature from an XML CoT message

Returns {
    geometry:
        | { coordinates: number[][][]; type: "Polygon" }
        | { coordinates: number[]; type: "Point" }
        | { coordinates: number[][]; type: "LineString" };
    id: string;
    path?: string;
    properties: {
        ackrequest?: { ackrequested: boolean; tag: string; uid: string };
        archived?: boolean;
        attachments?: string[];
        callsign: string;
        center: number[];
        chat?: {
            chatgrp: any;
            chatroom: string;
            groupOwner?: string;
            id: string;
            messageId?: string;
            parent?: string;
            senderCallsign: string;
        };
        contact?: {
            callsign?: string;
            endpoint?: string;
            name?: string;
            phone?: string;
        };
        course?: number;
        dest?: | {
            after?: string;
            callsign?: string;
            mission?: string;
            "mission-guid"?: string;
            path?: string;
            uid?: string;
        }
        | {
            after?: string;
            callsign?: string;
            mission?: string;
            "mission-guid"?: string;
            path?: string;
            uid?: string;
        }[];
        droid?: string;
        fileshare?: {
            filename: string;
            name: string;
            senderCallsign: string;
            senderUid: string;
            senderUrl: string;
            sha256: string;
            sizeInBytes: number;
        };
        fill?: string;
        "fill-opacity"?: number;
        flow?: { [key: string]: string };
        geofence?: {
            boundingSphere?: number;
            elevationMonitored?: string;
            maxElevation?: string;
            minElevation?: string;
            monitor?: string;
            tracking?: string;
            trigger?: string;
        };
        group?: { name: string; role: string };
        how: string;
        icon?: string;
        links?: {
            mime?: string;
            parent_callsign?: string;
            point?: string;
            production_time?: string;
            relation?: string;
            remarks?: string;
            type?: string;
            uid?: string;
            url?: string;
        }[];
        "marker-color"?: string;
        "marker-opacity"?: number;
        metadata?: { [key: string]: unknown };
        mission?: {
            authorUid?: string;
            guid?: string;
            missionChanges?: {
                contentUid: string;
                creatorUid: string;
                details: {
                    callsign: string;
                    color: string;
                    lat: string;
                    lon: string;
                    type: string;
                };
                isFederatedChange: string;
                missionName: string;
                timestamp: string;
                type: string;
            }[];
            missionLayer?: {
                name?: string;
                parentUid?: string;
                type?: string;
                uid?: string;
            };
            name?: string;
            tool?: string;
            type?: string;
        };
        precisionlocation?: { altsrc?: string; geopointsrc?: string };
        remarks?: string;
        sensor?: {
            azimuth?: number;
            displayMagneticReference?: number;
            elevation?: number;
            fov?: number;
            fovAlpha?: number;
            fovBlue?: number;
            fovGreen?: number;
            fovRed?: number;
            hideFov?: boolean;
            model?: string;
            north?: number;
            range?: number;
            rangeLines?: number;
            rangeLineStrokeColor?: number;
            rangeLineStrokeWeight?: number;
            roll?: number;
            strokeColor?: number;
            strokeWeight?: number;
            type?: string;
            version?: string;
            vfov?: number;
        };
        shape?: { ellipse?: { angle: number; major: number; minor: number } };
        slope?: number;
        speed?: number;
        stale: string;
        start: string;
        status?: { battery?: string; readiness?: string };
        stroke?: string;
        "stroke-opacity"?: number;
        "stroke-style"?: string;
        "stroke-width"?: number;
        takv?: {
            device?: string;
            os?: string;
            platform?: string;
            version?: string;
        };
        time: string;
        track?: {
            course?: string;
            eCourse?: string;
            eSlope?: string;
            eSpeed?: string;
            slope?: string;
            speed?: string;
        };
        type: string;
        video?: {
            connection?: {
                address: string;
                alias?: string;
                bufferTime?: number;
                ignoreEmbeddedKLV?: boolean;
                networkTimeout?: number;
                path?: string;
                port?: number;
                protocol?: string;
                roverPort?: number;
                rtspReliable?: number;
                uid: string;
            };
            sensor?: string;
            spi?: string;
            uid?: string;
            url?: string;
        };
    };
    type: string;
}
Inherited from default.to_geojson
- Defined in lib/cot.ts:334

to_proto

to_proto(version?: number): Uint8Array
Return an ATAK Compliant Protobuf
Parameters
- version: number = 1
Returns Uint8Array
Inherited from default.to_proto
- Defined in lib/cot.ts:295

to_xml

to_xml(): string
Returns string
Inherited from default.to_xml
- Defined in lib/cot.ts:643

uid

uid(uid?: string): string
Returns or sets the UID of the CoT
Parameters
- Optionaluid: string
Returns string
Inherited from default.uid
- Defined in lib/cot.ts:172

`Static`from_geojson

from_geojson(
    feature: {
        geometry:
            | { coordinates: number[][][]; type: "Polygon" }
            | { coordinates: number[]; type: "Point" }
            | { coordinates: number[][]; type: "LineString" };
        id?: string;
        path?: string;
        properties: {
            ackrequest?: { ackrequested: boolean; tag: string; uid: string };
            archived?: boolean;
            attachments?: string[];
            callsign?: string;
            center?: number[];
            chat?: {
                chatgrp: any;
                chatroom: string;
                groupOwner?: string;
                id: string;
                messageId?: string;
                parent?: string;
                senderCallsign: string;
            };
            contact?: {
                callsign?: string;
                endpoint?: string;
                name?: string;
                phone?: string;
            };
            course?: number;
            dest?: | {
                after?: string;
                callsign?: string;
                mission?: string;
                "mission-guid"?: string;
                path?: string;
                uid?: string;
            }
            | {
                after?: string;
                callsign?: string;
                mission?: string;
                "mission-guid"?: string;
                path?: string;
                uid?: string;
            }[];
            droid?: string;
            fileshare?: {
                filename: string;
                name: string;
                senderCallsign: string;
                senderUid: string;
                senderUrl: string;
                sha256: string;
                sizeInBytes: number;
            };
            fill?: string;
            "fill-opacity"?: number;
            flow?: { [key: string]: string };
            geofence?: {
                boundingSphere?: number;
                elevationMonitored?: string;
                maxElevation?: string;
                minElevation?: string;
                monitor?: string;
                tracking?: string;
                trigger?: string;
            };
            group?: { name: string; role: string };
            how?: string;
            icon?: string;
            links?: {
                mime?: string;
                parent_callsign?: string;
                point?: string;
                production_time?: string;
                relation?: string;
                remarks?: string;
                type?: string;
                uid?: string;
                url?: string;
            }[];
            "marker-color"?: string;
            "marker-opacity"?: number;
            metadata?: { [key: string]: unknown };
            mission?: {
                authorUid?: string;
                guid?: string;
                missionChanges?: {
                    contentUid: string;
                    creatorUid: string;
                    details: {
                        callsign: string;
                        color: string;
                        lat: string;
                        lon: string;
                        type: string;
                    };
                    isFederatedChange: string;
                    missionName: string;
                    timestamp: string;
                    type: string;
                }[];
                missionLayer?: {
                    name?: string;
                    parentUid?: string;
                    type?: string;
                    uid?: string;
                };
                name?: string;
                tool?: string;
                type?: string;
            };
            precisionlocation?: { altsrc?: string; geopointsrc?: string };
            remarks?: string;
            sensor?: {
                azimuth?: number;
                displayMagneticReference?: number;
                elevation?: number;
                fov?: number;
                fovAlpha?: number;
                fovBlue?: number;
                fovGreen?: number;
                fovRed?: number;
                hideFov?: boolean;
                model?: string;
                north?: number;
                range?: number;
                rangeLines?: number;
                rangeLineStrokeColor?: number;
                rangeLineStrokeWeight?: number;
                roll?: number;
                strokeColor?: number;
                strokeWeight?: number;
                type?: string;
                version?: string;
                vfov?: number;
            };
            shape?: { ellipse?: { angle: number; major: number; minor: number } };
            slope?: number;
            speed?: number;
            stale?: string | number;
            start?: string;
            status?: { battery?: string; readiness?: string };
            stroke?: string;
            "stroke-opacity"?: number;
            "stroke-style"?: string;
            "stroke-width"?: number;
            takv?: {
                device?: string;
                os?: string;
                platform?: string;
                version?: string;
            };
            time?: string;
            track?: {
                course?: string;
                eCourse?: string;
                eSlope?: string;
                eSpeed?: string;
                slope?: string;
                speed?: string;
            };
            type?: string;
            video?: {
                connection?: {
                    address: string;
                    alias?: string;
                    bufferTime?: number;
                    ignoreEmbeddedKLV?: boolean;
                    networkTimeout?: number;
                    path?: string;
                    port?: number;
                    protocol?: string;
                    roverPort?: number;
                    rtspReliable?: number;
                    uid: string;
                };
                sensor?: string;
                spi?: string;
                uid?: string;
                url?: string;
            };
        };
        type: string;
    },
): default
Return an CoT Message given a GeoJSON Feature
Parameters
- feature: {
      geometry:
          | { coordinates: number[][][]; type: "Polygon" }
          | { coordinates: number[]; type: "Point" }
          | { coordinates: number[][]; type: "LineString" };
      id?: string;
      path?: string;
      properties: {
          ackrequest?: { ackrequested: boolean; tag: string; uid: string };
          archived?: boolean;
          attachments?: string[];
          callsign?: string;
          center?: number[];
          chat?: {
              chatgrp: any;
              chatroom: string;
              groupOwner?: string;
              id: string;
              messageId?: string;
              parent?: string;
              senderCallsign: string;
          };
          contact?: {
              callsign?: string;
              endpoint?: string;
              name?: string;
              phone?: string;
          };
          course?: number;
          dest?: | {
              after?: string;
              callsign?: string;
              mission?: string;
              "mission-guid"?: string;
              path?: string;
              uid?: string;
          }
          | {
              after?: string;
              callsign?: string;
              mission?: string;
              "mission-guid"?: string;
              path?: string;
              uid?: string;
          }[];
          droid?: string;
          fileshare?: {
              filename: string;
              name: string;
              senderCallsign: string;
              senderUid: string;
              senderUrl: string;
              sha256: string;
              sizeInBytes: number;
          };
          fill?: string;
          "fill-opacity"?: number;
          flow?: { [key: string]: string };
          geofence?: {
              boundingSphere?: number;
              elevationMonitored?: string;
              maxElevation?: string;
              minElevation?: string;
              monitor?: string;
              tracking?: string;
              trigger?: string;
          };
          group?: { name: string; role: string };
          how?: string;
          icon?: string;
          links?: {
              mime?: string;
              parent_callsign?: string;
              point?: string;
              production_time?: string;
              relation?: string;
              remarks?: string;
              type?: string;
              uid?: string;
              url?: string;
          }[];
          "marker-color"?: string;
          "marker-opacity"?: number;
          metadata?: { [key: string]: unknown };
          mission?: {
              authorUid?: string;
              guid?: string;
              missionChanges?: {
                  contentUid: string;
                  creatorUid: string;
                  details: {
                      callsign: string;
                      color: string;
                      lat: string;
                      lon: string;
                      type: string;
                  };
                  isFederatedChange: string;
                  missionName: string;
                  timestamp: string;
                  type: string;
              }[];
              missionLayer?: {
                  name?: string;
                  parentUid?: string;
                  type?: string;
                  uid?: string;
              };
              name?: string;
              tool?: string;
              type?: string;
          };
          precisionlocation?: { altsrc?: string; geopointsrc?: string };
          remarks?: string;
          sensor?: {
              azimuth?: number;
              displayMagneticReference?: number;
              elevation?: number;
              fov?: number;
              fovAlpha?: number;
              fovBlue?: number;
              fovGreen?: number;
              fovRed?: number;
              hideFov?: boolean;
              model?: string;
              north?: number;
              range?: number;
              rangeLines?: number;
              rangeLineStrokeColor?: number;
              rangeLineStrokeWeight?: number;
              roll?: number;
              strokeColor?: number;
              strokeWeight?: number;
              type?: string;
              version?: string;
              vfov?: number;
          };
          shape?: { ellipse?: { angle: number; major: number; minor: number } };
          slope?: number;
          speed?: number;
          stale?: string | number;
          start?: string;
          status?: { battery?: string; readiness?: string };
          stroke?: string;
          "stroke-opacity"?: number;
          "stroke-style"?: string;
          "stroke-width"?: number;
          takv?: {
              device?: string;
              os?: string;
              platform?: string;
              version?: string;
          };
          time?: string;
          track?: {
              course?: string;
              eCourse?: string;
              eSlope?: string;
              eSpeed?: string;
              slope?: string;
              speed?: string;
          };
          type?: string;
          video?: {
              connection?: {
                  address: string;
                  alias?: string;
                  bufferTime?: number;
                  ignoreEmbeddedKLV?: boolean;
                  networkTimeout?: number;
                  path?: string;
                  port?: number;
                  protocol?: string;
                  roverPort?: number;
                  rtspReliable?: number;
                  uid: string;
              };
              sensor?: string;
              spi?: string;
              uid?: string;
              url?: string;
          };
      };
      type: string;
  }
  GeoJSON Point Feature
Returns default
Inherited from default.from_geojson
- Defined in lib/cot.ts:910

`Static`from_proto

from_proto(raw: Uint8Array, version?: number): default
Parse an ATAK compliant Protobuf to a JS Object
Parameters
- raw: Uint8Array
- version: number = 1
Returns default
Inherited from default.from_proto
- Defined in lib/cot.ts:830

`Static`ping

ping(): default
Return a CoT Message

Returns default
Inherited from default.ping
- Defined in lib/cot.ts:893

Class DirectChat

Param: cot

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DirectChat

Properties

metadata

path

raw

Methods

addDest

Parameters

Returns default

addLink

Parameters

Returns default

addVideo

Parameters

Returns default

callsign

Parameters

Returns string

is_airborne

Returns boolean

is_assumed

Returns boolean

is_atom

Returns boolean

is_chat

Returns boolean

is_equipment

Returns boolean

is_faker

Returns boolean

is_friend

Returns boolean

is_ground

Returns boolean

is_hostile

Returns boolean

is_installation

Returns boolean

is_joker

Returns boolean

is_neutral

Returns boolean

is_pending

Returns boolean

is_subsurface

Returns boolean

is_surface

Returns boolean

is_suspect

Returns boolean

is_tasking

Returns boolean

is_uav

Returns boolean

is_unknown

Returns boolean

is_vehicle

Returns boolean

isDiff

Parameters

Returns boolean

position

Parameters

Returns number[]

sensor

Parameters

Returns null | { coordinates: number[][][]; type: "Polygon" }

to_geojson

to_proto

Parameters

`Static`from_geojson

`Static`from_proto

`Static`ping