Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDrawingParameterSettings

General properties of a drawing tools parameter.

Hierarchy

  • IDrawingParameterSettings

Index

Properties

Properties

Optional general

general?: { options?: { showDistanceLabels?: boolean; showPointLabels?: boolean; snapToEdges?: boolean; snapToFaces?: boolean; snapToVertices?: boolean }; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string } }

Type declaration

  • Optional options?: { showDistanceLabels?: boolean; showPointLabels?: boolean; snapToEdges?: boolean; snapToFaces?: boolean; snapToVertices?: boolean }
    • Optional showDistanceLabels?: boolean

      If true, the distance labels are shown. (default: true)

    • Optional showPointLabels?: boolean

      If true, the point labels are shown. (default: false)

    • Optional snapToEdges?: boolean

      If true, the snapping to edges is enabled, if there is a geometry restriction. (default: true)

    • Optional snapToFaces?: boolean

      If true, the snapping to faces is enabled, if there is a geometry restriction. (default: true)

    • Optional snapToVertices?: boolean

      If true, the snapping to vertices is enabled, if there is a geometry restriction. (default: true)

  • Optional prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }

    A prompt that can be defined which is displayed instead of the default prompt.

    • Optional activeText?: string

      The text when the parameter is inactive.

    • Optional activeTitle?: string

      The title when the parameter is active.

    • Optional inactiveTitle?: string

      The title when the parameter is inactive.

Optional geometry

geometry?: { autoClose: boolean; close: boolean; mode: "points" | "lines"; maxPoints?: number; minPoints?: number }

Type declaration

  • autoClose: boolean

    If the mode is set to 'lines', if the line is automatically closed. If the mode is set to 'points', this setting is ignored.

    The first and last point are always connected if the line is automatically closed.

    default

    true

  • close: boolean

    If the mode is set to 'lines', if it is a closed line or not. If the mode is set to 'points', this setting is ignored.

    A line can be closed by connecting the last point with the first point.

    default

    true

  • mode: "points" | "lines"

    The mode of the geometry.

    If the mode is set to 'lines', the points are connected in the order they are defined. If the mode is set to 'points', the points are not connected.

    default

    'lines'

  • Optional maxPoints?: number

    The maximum amount of points, if undefined, the geometry is not restricted. This value is checked whenever the user tries to update or finish the drawing tool.

    default

    undefined

  • Optional minPoints?: number

    The minimum amount of points, if undefined, the geometry is not restricted. This value is checked whenever the user tries to update or finish the drawing tool.

    default

    undefined

Optional restrictions

restrictions?: RestrictionDefinition[]