Options
All
  • Public
  • Public/Protected
  • All
Menu

marker.js 2 Class Reference

Index

Classes

Interfaces

Type aliases

Type aliases

ArrowType

ArrowType: "both" | "start" | "end" | "none"

Represents available arrow types.

  • both - arrow tips on both sides.
  • start - arrow tip on the starting point of line.
  • end - arrow tip on the ending point of line.
  • none - no arrow tips.

ArrowTypeChangeHandler

ArrowTypeChangeHandler: (newType: ArrowType) => void

Handler for arrow type change event.

Type declaration

CloseEventHandler

CloseEventHandler: () => void

Event handler type for MarkerArea close event.

Type declaration

    • (): void

    • Returns void

ColorChangeHandler

ColorChangeHandler: (newColor: string) => void

Handler type for the color change event.

Type declaration

    • (newColor: string): void

    • Parameters

      • newColor: string

      Returns void

ColorSet

ColorSet: string[]

Represents a list of colors.

DisplayMode

DisplayMode: "inline" | "popup"

marker.js 2 display mode - inline or popup.

EventHandler

EventHandler<T>: T extends "markerselect" ? MarkerEventHandler : T extends "markerdeselect" ? MarkerEventHandler : T extends "markercreating" ? MarkerEventHandler : T extends "markercreate" ? MarkerEventHandler : T extends "markerbeforedelete" ? MarkerEventHandler : T extends "markerdelete" ? MarkerEventHandler : T extends "markerchange" ? MarkerEventHandler : T extends "render" ? MarkerAreaRenderEventHandler : MarkerAreaEventHandler

Event handler type for a specific event type.

Type parameters

FontChangeHandler

FontChangeHandler: (newFont: string) => void

Font change event handler type.

Type declaration

    • (newFont: string): void

    • Parameters

      • newFont: string

      Returns void

MarkerAreaEventHandler

MarkerAreaEventHandler: (event: MarkerAreaEvent) => void

General MarkerArea event handler type.

Type declaration

MarkerAreaRenderEventHandler

MarkerAreaRenderEventHandler: (event: MarkerAreaRenderEvent) => void

MarkerArea render event handler type.

Type declaration

MarkerEventHandler

MarkerEventHandler: (event: MarkerEvent) => void

Marker event handler type.

Type declaration

MarkerState

MarkerState: "new" | "creating" | "select" | "move" | "resize" | "rotate" | "edit"

Represents marker's state (status) in time.

MarkerTypeIdentifier

MarkerTypeIdentifier: string | typeof MarkerBase

Identifier for marker type when setting availableMarkerTypes. Marker type can be set as either a string or a marker type reference.

OpacityChangeHandler

OpacityChangeHandler: (newOpacity: number) => void

Opacity change event handler type.

Type declaration

    • (newOpacity: number): void

    • Parameters

      • newOpacity: number

      Returns void

RenderEventHandler

RenderEventHandler: (dataURL: string, state?: MarkerAreaState) => void

Event handler type for MarkerArea render event.

Type declaration

StyleChangeHandler

StyleChangeHandler: (newStyle: string) => void

Line style change event handler type.

Type declaration

    • (newStyle: string): void

    • Parameters

      • newStyle: string

      Returns void

ToolbarButtonClickHandler

ToolbarButtonClickHandler: (buttonType: ToolbarButtonType, value?: typeof MarkerBase | string) => void

Click handler type for toolbar button click events.

Type declaration

    • Parameters

      Returns void

ToolbarButtonType

ToolbarButtonType: "action" | "marker"

Toolbar button type:

  • action for non-marker buttons like select, delete, etc.
  • marker for marker type buttons.

WidthChangeHandler

WidthChangeHandler: (newWidth: number) => void

Line width change event handler type.

Type declaration

    • (newWidth: number): void

    • Parameters

      • newWidth: number

      Returns void

Generated using TypeDoc