Type alias DrawOptions

DrawOptions: {
    keybindings?: boolean;
    boxSelect?: boolean;
    clickBuffer?: number;
    displayControlsDefault?: boolean;
    controls?: MaplibreDrawControls;
    measure?: boolean;
    showIcon?: boolean;
    iconRemovable?: boolean;
    resultPosition?: "centroid" | "lastPoint" | "none";
    resultOffset?: [number, number];
    lengthUnit?: "miles" | "kilometers";
    boxColor?: color | string;
    boxBorderColor?: color | string;
    boxPosition?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "none";
    textColor?: color | string;
    draggable?: boolean;
    fixedNumber?: number;
}

드로우 컨트롤(DrawControl)을 생성할 때 파라미터로 들어가는 DrawOptions 입니다. 드로우 컨트롤 생성은 DrawControl을 참고해주세요.

Type declaration

  • Optional keybindings?: boolean

    키보드를 이용한 DrawControl 조작 설정 여부입니다. 해당 옵션이 true인 경우

    • 1, 2, 3를 사용하여 점, 선, 다각형을 그릴 수 있습니다.
    • esc를 사용하여 현재 사용중인 mode에서 탈출할 수 있습니다.
    • delete, backspace를 사용하여 선택한 도형을 삭제할 수 있습니다.
    • enter를 사용하여 그리던 도형을 완성할 수 있습니다.

    Default

    true
    
  • Optional boxSelect?: boolean

    boxSelect를 이용한 feature 선택 기능 활성화 여부입니다. shift + click + drag 를 사용하여 여러 도형을 한번에 선택할 수 있습니다. 만약 이 값이 false라면 shift + click + drag 를 사용하여 지도의 default 기능으로 해당 부분을 확대할 수 있습니다.

    Default

    true
    
  • Optional clickBuffer?: number

    도형이나 특정 포인트를 클릭할 때 반응하는 영역의 범위를 픽셀 단위로 조정할 수 있습니다. 숫자가 커질수록 반응하는 영역이 커지게 됩니다.

    Default

    2
    
  • Optional displayControlsDefault?: boolean

    DrawControl에 특정 기능만 버튼으로 표출되도록 커스터마이징할 수 있습니다.

    • 해당 값을 true로 지정하면 DrawControl에서 제공하는 모든 기능이 버튼으로 표출됩니다.
    • 해당 값을 false로 지정하고 controls 의 값을 지정하면 해당되는 기능만 제공됩니다.
    • 해당 값을 false로 지정하고 controls 의 값을 지정하지 않으면 control이 표출되지 않습니다.

    Default

    true
    
  • Optional controls?: MaplibreDrawControls

    DrawControl에서 버튼으로 표출할 기능만 명시하여 사용할 수 있습니다. 해당 기능을 사용하기 위해선 displayControlsDefault 의 값이 false로 설정되어야 합니다. 사용 가능한 Key는 point, line_string, polygon, trash, combine_features, uncombine_features, srmode 이고, 해당 기능 버튼을 표출할 것인지에 대한 boolean 값을 value로 지정해주어야 합니다.

    type MaplibreDrawControls = {
    point?: boolean | undefined;
    line_string?: boolean | undefined;
    polygon?: boolean | undefined;
    trash?: boolean | undefined;
    combine_features?: boolean | undefined;
    uncombine_features?: boolean | undefined;
    srmode?: boolean | undefined;
    }
  • Optional measure?: boolean

    측정 함수 호출 여부입니다. 해당 옵션을 false로 설정한 경우 측정과 관련된 함수를 호출하지 않고, 측정 결과와 관련된 옵션을 true로 설정해도 결과가 표출되지 않습니다.

    Default

    false
    
  • Optional showIcon?: boolean

    측정 결과와 중간 결과의 표출을 조작할 수 있는 마커 표출 여부입니다. 해당 옵션을 true로 설정한 경우 측정 결과 표출 여부를 조작할 수 있는 마커가 표출됩니다.

    Default

    true;
    
  • Optional iconRemovable?: boolean

    showIcon 마커 제거 옵션입니다. 해당 옵션이 true인 경우 showIcon 에 마우스를 올렸을 때 마커를 제거할 수 있는 x 표시가 표출됩니다.

    Default

    false;
    
  • Optional resultPosition?: "centroid" | "lastPoint" | "none"

    측정 결과가 표시될 위치입니다. 제공되는 옵션은 centroid, lastPoint, none입니다.

    • 해당 값이 centroid이고 측정하는 feature가 polygon인 경우 polygon의 무게중심에 측정결과가 표출됩니다.
    • 해당 값이 lastPoint인 경우 마지막으로 추가된 vertex에 측정결과가 표출됩니다.
    • 해당 값이 none인 경우 최종 측정결과가 표출되지 않습니다.

    Default

    'centroid'
    
  • Optional resultOffset?: [number, number]

    측정 결과의 Offset 입니다. 중심을 기준으로 이동시킬 오프셋(픽셀). [x,y]형식이며, 음수는 왼쪽과 위쪽을 나타냅니다.

    Default

    [0.0006, 0.0003]
    
  • Optional lengthUnit?: "miles" | "kilometers"

    길이 측정 결과의 단위입니다. 제공되는 옵션은 kilometersmiles입니다.

    • 해당 값이 kilometers인 경우 길이 측정의 결과가 kilometers로 표출됩니다.
    • 해당 값이 miles인 경우 길이 측정의 결과가 miles로 표출됩니다.

    Default

    'kilometers'
    
  • Optional boxColor?: color | string

    표출되는 측정 결과의 뒷 배경 색 지정 옵션입니다. 해당 값을 옵션에 포함하지 않는 경우, 뒷 배경이 투명하게, 측정 결과가 text로만 표출됩니다. 해당 값에 color를 설정하면 뒷 배경의 색상으로 표출됩니다.

    Default

    undefined
    
  • Optional boxBorderColor?: color | string

    표출되는 측정 결과의 배경 테두리 색 옵션입니다. 해당 값을 옵션에 포함하지 않는 경우, 배경 테두리가 투명하게 표출됩니다. 해당 값에 color를 설정하면 그 값이 배경 테두리 색상으로 표출됩니다.

    Default

    undefined
    
  • Optional boxPosition?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "none"

    길이 측정 시 표출되는 중간 결과의 표출 위치 옵션입니다. 길이 측정 시 추가한 vertex를 기준으로 결과를 어디에 표출할지 설정할 수 있습니다. 해당 값이 none인 경우 중간 결과가 표출되지 않습니다.

    Default

    "center"
    
  • Optional textColor?: color | string

    표출되는 측정 결과의 text 색 옵션입니다. 해당 값에 color를 설정하면 측정 결과의 text 색상으로 표출됩니다.

    Default

    "#000000"
    
  • Optional draggable?: boolean

    측정 결과 라벨의 드래그 가능 여부 설정 옵션입니다.

    • 해당 값이 true인 경우 측정 결과 라벨을 드래그할 수 있습니다.
    • 해당 값이 false인 경우 측정 결과 라벨을 드래그할 수 없습니다.

    Default

    false
    
  • Optional fixedNumber?: number

    측정 결과의 소수점 뒤에 나타날 자릿수입니다. 0 이상 20 이하의 값을 사용할 수 있습니다.

    Default

    5
    

Generated using TypeDoc