[API/UI]

GuideType

개요

GuideType 클래스는 위젯 형태의 guide를 제공합니다.
GuideType 클래스의 주요 기능은 다음과 같습니다.
1. GuideType 클래스는 MethodChain의 입력과 관련된 콤포넌트(mc.types.+++)와 연동합니다.
    - 예를 들어 TextType 클래스를 사용하여 입력한 데이터에서 에러가 발생하면 자동으로 Guide 위젯이 표시됩니다.
    - FormType 클래스와 같이 다수의 컴포넌트를 사용하는 경우
      - 첫 번째 에러에 대한 Guide 위젯이 표시되고
      - 에러를 수정하면 다음 에러에 대한 Guide 위젯이 자동으로 표시됩니다.

2. MethodChain의 입력과 관련된 컴포넌트와 자동으로 연동하므로 별도로 GuideType를 생성하지 않아도 됩니다.

3. 표시된 Guide widget을 마우스로 Drag할 수 있습니다.

4. 에러가 소멸되면 표시되었던 Guide 위젯이 자동으로 사라집니다.
Options Component
ccode {String} guide.GuideType
component code : 'guidetype'
prefix {String} guide.GuideType
id 접두사. default: 'mc_guidetype_'
showXY {Boolean} guide.GuideType
GuideType을 표시하는 위치 기준.
false: X축 기준, true: Y축 기준
false: Guide 표시 기준 엘리먼트의 X축에 표시
true: Guide 표시 기준 엘리먼트의 Y축에 표시
xOffset {Number} guide.GuideType
대상 엘리먼트와 Guide의 right 간격.
Guide 대상 엘리먼트에서 Guide 표시할 우측 간격을 지정합니다.
yOffset {Number} guide.GuideType
대상 엘리먼트와 Guide의 bottom 간격.
Guide 대상 엘리먼트에서 Guide 표시할 bottom 간격을 지정합니다.
Method Component
show (HTMLElement, String, String)
show(el, tit, html)
guide message를 표시합니다.
Parameters :
• {HTMLElement} element, Guide 설정 대상 엘리먼트.
문자열이 아닌 HTMLElement를 지정해야 합니다.
• {String} title, Guide title
• {String} html, Guide에 표시할 message(html)
Returns :
• 없음
guide.GuideType
guide message를 표시합니다.
hide ()
hide()
guide message를 숨김니다.
Parameters :
• 없음
Returns :
• 없음
guide.GuideType
guide message를 숨김니다.
Custom Event Component