API Guide
Scatter Analytics 사용법
시작하기
Scatter Analytics는 자바스크립트와 CSS를 CDN으로 지원합니다.
아래의 링크를 사용하세요.
<link rel="stylesheet" href="https://scatterx.scatteranalytics.io/chart/cdn/api.css"/>
<script src="https://scatterx.scatteranalytics.io/chart/cdn/api.js"/>
간단한 사용법
차트를 출력하기 위한 간단한 사용 방법입니다.
<div id="app"></div>
<script>
ScatterX.chart("#app", {
   load_type: "data_store",
   table_name: "store.DATA_20210430_154906_233"
});
</script>
API
1. ScatterX.chart
차트를 생성하는 API
ScatterX.chart(selector, option);
Name Type Required Description
selector Selector O 선택 표현식을 포함하는 문자열
option Object O 차트 출력을 위한 설정
1-1. Option
차트 출력을 위한 설정으로 로드 유형(Load Type)에 따른 필요한 파라미터를 설정한다.
var option = {
   load_type: load_type,
   // Load Type : Data Store
   table_name: table_name,
   // Load Type : DB
   db_name: db_name,
   db_query: db_query,
   ac_name: ac_name,
   index_definition: index_definition,
   // Load Type : DB Custom
   db_type: db_type,
   db_jdbc_url: db_jdbc_url,
   db_jdbc_driver: db_jdbc_driver,
   db_user_name: db_user_name,
   db_password: db_password,
   // Load Type : File Path
   file_path: file_path,
   alt_data_file_path: alt_data_file_path,
   hdfs_proxy_user: hdfs_proxy_user,
   file_source_name: file_source_name,
   file_username: file_username,
   file_password: file_password,
   s3_accesskey: s3_accesskey,
   s3_secretkey: s3_secretkey,
   s3_endpoint: s3_endpoint,
   s3_regionname: s3_regionname,
   best_effort: best_effort,
   delimiter: delimiter,
   quote: quote,
   skip_header: skip_header,
   null_as: null_as,
   suffix: suffix,
   encoding: encoding,
   compression: compression,
   contents_schema: contents_schema,
   // Load Type : Parquet
   timezone: timezone,
   parsing_type: parsing_type,
   // Load Type : Job ID
   job_id: job_id,
   // Load Type : Template
   index: index,
   data: data,
   // Draw Parameter
   draw_parameter: draw_parameter,
   filter: filter,
   control_limit: control_limit,
   // Load Type : ICSR
   link_option: link_option
};
Name Type Required Description
load_type String O 로드 유형을 설정하는 값으로 다음의 값을 사용할 수 있음
  • data_store
  • db
  • db_custom
  • file_path
  • parquet
  • job_id
  • template
  • unit
  • icsr
table_name String △ (*load_type이 data_store일 때)
Data Store에 등록된 테이블 이름
db_name String △ (*load_type이 db일 때)
관리자 페이지에 등록된 데이터소스관리의 데이터소스명
db_query String △ (*load_type이 db / db_custom일 때)
데이터베이스에서 실행할 쿼리
ac_name String △ (*load_type이 db / db_custom / file_path일 때)
Data Store에 등록될 이름(아카이브명)
index_definition Array △ (*load_type이 db / db_custom / file_path / parquet일 때)
데이터 적재후 생성할 인덱스의 정의
지원 데이터베이스
  • Oracle
  • Greenplum
db_type String △ (*load_type이 db_custom일 때)
데이터베이스 유형
  • Altibase
  • Oracle
  • Greenplum
  • PostgreSQL
db_jdbc_url String △ (*load_type이 db_custom일 때)
JDBC url
db_jdbc_driver String △ (*load_type이 db_custom일 때)
JDBC driver
db_user_name String △ (*load_type이 db_custom일 때)
데이터베이스 사용자 이름
db_password String △ (*load_type이 db_custom일 때)
데이터베이스 사용자 비밀번호
file_path String △ (*load_type이 file_path일 때)
파일이 위치한 경로
  • 디렉토리를 사용하면 해당 디렉토리 안에 들어있는 모든 파일을 로드
  • 파일명을 사용하면 해당 파일을 로드
  • file_source_name 옵션을 사용할 경우 관리자 페이지의 데이터소스관리에 등록된 루트(ROOT)경로를 제외한 나머지 경로만 입력해야 함
    • Full path Example → sftp://host.example.com:22/path/file/file.csv
    • Root path Example → sftp://host.example.com:22/path
    • file_path Example → /file.csv
alt_data_file_path String △ (*load_type이 file_path일 때)
file_path 외 추가적인 파일경로
  • sftp를 사용하는 경우 sftp의 주소정보를 제외한 나머지 절대경로를 입력해야 함
    • file_path Example → sftp://host.example.com:22/path/file/file.csv
    • alt_data_file_path Example → /path/file/file.csv
  • hdfs를 사용하는 경우 hdfs 프로토콜을 포함한 전체주소를 입력해야 함
hdfs_proxy_user String X (*load_type이 file_path, parquet일 때)
HDFS 프록시 사용자
(기본값 : 사용자 아이디)
file_source_name String △ (*load_type이 file_path일 때)
관리자 페이지에 등록된 데이터소스관리의 데이터소스명
file_username String △ (*load_type이 file_path일 때)
파일이 위치한 경로로 접속할 때 사용자 인증을 위한 유저 이름 정보
  • file_source_name옵션이 설정되지 않은 경우에만 사용
file_password String △ (*load_type이 file_path일 때)
파일이 위치한 경로로 접속할 때 사용자 인증을 위한 유저 패스워드 정보
  • file_source_name옵션이 설정되지 않은 경우에만 사용
s3_accesskey String △ (*load_type이 file_path일 때)
Access key
  • S3 로드일 경우에만 사용
s3_secretkey String △ (*load_type이 file_path일 때)
Secret key
  • S3 로드일 경우에만 사용
s3_endpoint String X (*load_type이 file_path일 때)
엔드포인트
  • S3 로드일 경우에만 사용
s3_regionname String △ (*load_type이 file_path일 때)
리전
  • S3 로드일 경우에만 사용
best_effort Boolean X (*load_type이 file_path일 때)
CSV 데이터에 오류가 존재하여도 Skip하여 계속 처리할지의 여부
delimiter String △ (*load_type이 file_path일 때)
구분자
quote String △ (*load_type이 file_path일 때)
따옴표
skip_header Boolean △ (*load_type이 file_path일 때)
첫 줄의 Header 여부
null_as String △ (*load_type이 file_path일 때)
null 값 정의
suffix String △ (*load_type이 file_path일 때)
파일의 접미사
encoding String X (*load_type이 file_path일 때)
파일 인코딩
(기본값 : UTF-8)
compression String △ (*load_type이 file_path일 때)
압축형태
contents_schema Array △ (*load_type이 file_path일 때)
데이터의 스키마 정보
timezone String △ (*load_type이 parquet일 때)
Parquet의 int96타입을 timestamp 형식으로 변환시 적용할 타임존 이름
  • Asia/Seoul
  • Europe/London
  • UTC(*Default)
    • 더보기
parsing_type String △ (*load_type이 parquet일 때)
데이터 파서를 멀티서버에서 할 것인지 지정
  • Single(*Default)
  • Multi
job_id String △ (*load_type이 job_id일 때)
이미 그려진 차트에 한하여 다시 불러올 때 사용하는 Job ID 값
index Number △ (*load_type이 template일 때)
미리 저장된 Template의 Index 값
data Array △ (*load_type이 template일 때)
불러올 Template 레이아웃에 바인딩할 Data의 정보

(*load_type이 icsr일 때)
시각화할 데이터
draw_parameter Object X 차트를 그릴 때 사용하는 파라미터
filter Array X 차트를 그릴 때 조건으로 사용할 필터
control_limit Object X (*load_type이 data_store, db, db_custom, file_path, parquet일 때)
Control Limit을 설정하는 옵션
link_option Array X (*load_type이 icsr일 때)
ICSR 차트를 연결할 때 사용하는 옵션
1-1-1. Load Type : Data Store
Data Store에 등록된 테이블을 사용하여 데이터를 로드할 때 예시
ScatterX.chart("#app", {
   load_type: "data_store",
   table_name: "store.DATA_20210430_154906_233"
});
1-1-2. Load Type : DB
관리자 페이지에 등록된 데이터소스관리의 데이터소스명으로 데이터를 로드할 때 예시
ScatterX.chart("#app", {
   load_type: "db",
   db_name: "IOTDB",
   db_query: "select * from iot.sensor_value limit 1000",
   ac_name: "IOT",
   index_definition: ["(column1)", "(column2)"]
});
1-1-3. Load Type : DB Custom
JDBC 접속정보를 설정하여 데이터를 로드할 때 예시
ScatterX.chart("#app", {
   load_type: "db_custom",
   db_type: "PostgreSQL",
   db_jdbc_url: "jdbc:postgresql://192.168.0.190:5432/iotdb",
   db_jdbc_driver: "org.postgresql.Driver",
   db_user_name: "scatterx.user",
   db_password: "scatterx1234",
   db_query: "select * from iot.sensor_value limit 1000",
   ac_name: "IOT Test Data",
   index_definition: ["(column1)", "(column2)"]
});
1-1-4. Load Type : File Path
파일 경로에서 데이터를 로드할 때 예시
// 비압축
ScatterX.chart("#app", {
   load_type: "file_path",
   file_path: "hdfs://192.168.0.160:9000/data/flight_2017",
   alt_data_file_path: ["hdfs://<server>:<port>/<path>"],
   delimiter: ",",
   quote: "\"",
   skip_header: true,
   null_as: "",
   suffix: ".csv",
   ac_name: "Flight Data 1",
   index_definition: ["(column1)", "(column2)"],
   contents_schema: [
      {name: "year_", type: "integer"},
      {name: "month_", type: "integer"},
      {name: "day_of_month", type: "integer"},
      {name: "day_of_week", type: "integer"},
      {name: "fl_date", type: "timestamp", dateformat: "yyyy-MM-dd HH:mm:ss.SSS"},
      {name: "op_unique_carrier", type: "string"},
      {name: "tail_num", type: "string"},
      {name: "op_carrier_fl_num", type: "integer"},
      {name: "origin", type: "string"},
      {name: "dest", type: "string"},
      {name: "crs_dep_time", type: "integer"},
      {name: "dep_time", type: "integer"},
      {name: "dep_delay", type: "integer"},
      {name: "taxi_out", type: "integer"},
      {name: "taxi_in", type: "integer"},
      {name: "crs_arr_time", type: "integer"},
      {name: "arr_time", type: "integer"},
      {name: "arr_delay", type: "integer"},
      {name: "cancelled", type: "integer"},
      {name: "cancellation_code", type: "string"},
      {name: "diverted", type: "string"},
      {name: "crs_elapsed_time", type: "integer"},
      {name: "actual_elapsed_time", type: "integer"},
      {name: "air_time", type: "integer"},
      {name: "distance", type: "integer"},
      {name: "carrier_delay", type: "integer"},
      {name: "weather_delay", type: "integer"},
      {name: "nas_delay", type: "integer"},
      {name: "security_delay", type: "integer"},
      {name: "late_aircraft_delay", type: "integer"},
      {name: "upper_limit", type: "integer"},
      {name: "target_limit", type: "double"},
      {name: "lower_limit", type: "integer"}
   ]
});

// 압축
ScatterX.chart("#app", {
   load_type: "file_path",
   file_path: "http://iot.scatteranalytics.io:9080/data/flight/flight_2017.csv.gz",
   alt_data_file_path: ["http://<server>:<port>/<path>"],
   delimiter: ",",
   quote: "\"",
   skip_header: true,
   null_as: "",
   compression: "Gzip",
   ac_name: "Flight Data 2",
   index_definition: ["(column1)", "(column2)"],
   contents_schema: [
      {name: "year_", type: "integer"},
      {name: "month_", type: "integer"},
      {name: "day_of_month", type: "integer"},
      {name: "day_of_week", type: "integer"},
      {name: "fl_date", type: "timestamp"},
      {name: "op_unique_carrier", type: "string"},
      {name: "tail_num", type: "string"},
      {name: "op_carrier_fl_num", type: "integer"},
      {name: "origin", type: "string"},
      {name: "dest", type: "string"},
      {name: "crs_dep_time", type: "integer"},
      {name: "dep_time", type: "integer"},
      {name: "dep_delay", type: "integer"},
      {name: "taxi_out", type: "integer"},
      {name: "taxi_in", type: "integer"},
      {name: "crs_arr_time", type: "integer"},
      {name: "arr_time", type: "integer"},
      {name: "arr_delay", type: "integer"},
      {name: "cancelled", type: "integer"},
      {name: "cancellation_code", type: "string"},
      {name: "diverted", type: "string"},
      {name: "crs_elapsed_time", type: "integer"},
      {name: "actual_elapsed_time", type: "integer"},
      {name: "air_time", type: "integer"},
      {name: "distance", type: "integer"},
      {name: "carrier_delay", type: "integer"},
      {name: "weather_delay", type: "integer"},
      {name: "nas_delay", type: "integer"},
      {name: "security_delay", type: "integer"},
      {name: "late_aircraft_delay", type: "integer"},
      {name: "upper_limit", type: "integer"},
      {name: "target_limit", type: "double"},
      {name: "lower_limit", type: "integer"}
   ]
});
1-1-5. Load Type : Parquet
해당 HDFS 위치상에 존재하는 데이터를 로드할 때 예시
(*지정한 파일위치가 디렉토리일 경우 내부 모든 파일이 적재되고 단일파일이면 해당 파일만 적재)
ScatterX.chart("#app", {
   load_type: "parquet",
   file_path: "hdfs://<server>:<port>/<path>"
   alt_data_file_path: ["hdfs://<server>:<port>/<path>"],
   hdfs_proxy_user: "hadoop",
   timezone: "Asia/Seoul",
   parsing_type: "Single",
   ac_name: "Parquet Data",
   index_definition: ["(column1)", "(column2)"]
});
1-1-6. Load Type : Job ID
이전에 그린 차트를 Job ID로 다시 불러올 때 예시 (도구 및 기타 기능 사용 가능)
ScatterX.chart("#app", {
   load_type: "job_id",
   job_id: "20201230_164712_29482"
});
1-1-7. Load Type : Live Image
이전에 그린 차트를 Job ID로 다시 불러올 때 예시 (툴팁 기능만 사용 가능)
ScatterX.chart("#app", {
   load_type: "live_image",
   job_id: "20201230_164712_29482"
});
1-1-8. Load Type : Template
Template으로 저장된 레이아웃에 데이터만 바인딩하여 차트를 출력할 때 예시
// 레이아웃 index로 실행할 때
ScatterX.chart("#app", {
   load_type: "template",
   index: 1,
   data: [
      {index: 0, table_name: "store.DATA_20210430_154906_233"},
      {index: 1, table_name: "store.DATA_20210430_154906_233"},
      {index: 2, table_name: "store.DATA_20210430_154906_233"},
      {index: 3, table_name: "store.DATA_20210430_154906_233"}
   ]
});
// 레이아웃 name으로 실행할 때
ScatterX.chart("#app", {
   load_type: "template",
   index: 1,
   data: [
      {name: "Scatter", table_name: "store.DATA_20210430_154906_233"},
      {name: "Line (2)", table_name: "store.DATA_20210430_154906_233"},
      {name: "Bar (3)", table_name: "store.DATA_20210430_154906_233"},
      {name: "Boxplot (4)", table_name: "store.DATA_20210430_154906_233"}
   ]
});
1-1-9. Load Type : Unit
단일 차트로 데이터를 불러와서 사용할 때 예시
ScatterX.chart("#app", {
   load_type: "unit",
   table_name: "store.DATA_20210430_154906_233",
   draw_parameter: {
      chart_type: "line",
      auto_draw: true,
      color: ["op_unique_carrier"],
      x: ["fl_date"],
      y1: ["dep_delay"]
   }
});
1-1-10. Load Type : ICSR
데이터를 직접 바인딩하여 사용할 때 예시
var data = [
   {"origin": "DFW", "dest": "CLT", "dep_delay": 20, "arr_delay": 30},
   {"origin": "DFW", "dest": "CLT", "dep_delay": -2, "arr_delay": -7},
   {"origin": "DFW", "dest": "CLT", "dep_delay": -8, "arr_delay": -25},
   {"origin": "DFW", "dest": "CLT", "dep_delay": -1, "arr_delay": 3},
   {"origin": "DFW", "dest": "CLT", "dep_delay": -2, "arr_delay": -5},
   {"origin": "DFW", "dest": "CLT", "dep_delay": -1, "arr_delay": 18},
   {"origin": "DFW", "dest": "CLT", "dep_delay": -3, "arr_delay": -8},
   {"origin": "DFW", "dest": "CLT", "dep_delay": -5, "arr_delay": -15},
   {"origin": "DFW", "dest": "CLT", "dep_delay": -5, "arr_delay": -9},
   {"origin": "DFW", "dest": "CLT", "dep_delay": -7, "arr_delay": 4},
   {"origin": "DFW", "dest": "CLT", "dep_delay": 2, "arr_delay": -2},
   {"origin": "DFW", "dest": "CLT", "dep_delay": -6, "arr_delay": -4},
   {"origin": "IAH", "dest": "CLT", "dep_delay": 147, "arr_delay": 156},
   {"origin": "IAH", "dest": "CLT", "dep_delay": -5, "arr_delay": -15},
   {"origin": "IAH", "dest": "CLT", "dep_delay": -7, "arr_delay": -15},
   {"origin": "IAH", "dest": "CLT", "dep_delay": -5, "arr_delay": -14},
   {"origin": "IAH", "dest": "CLT", "dep_delay": 3, "arr_delay": -5},
   {"origin": "PHL", "dest": "RDU", "dep_delay": -7, "arr_delay": -16},
   {"origin": "PHL", "dest": "RDU", "dep_delay": null, "arr_delay": null},
   {"origin": "PHL", "dest": "RDU", "dep_delay": 67, "arr_delay": 60},
   {"origin": "RDU", "dest": "PHL", "dep_delay": -8, "arr_delay": -23},
   {"origin": "MSY", "dest": "PHL", "dep_delay": -11, "arr_delay": -31},
   {"origin": "MSY", "dest": "PHL", "dep_delay": 3, "arr_delay": 9},
   {"origin": "MSY", "dest": "PHL", "dep_delay": -7, "arr_delay": -12},
   {"origin": "MSY", "dest": "PHL", "dep_delay": -7, "arr_delay": -33},
   {"origin": "MSY", "dest": "PHL", "dep_delay": -8, "arr_delay": -18},
   {"origin": "MSY", "dest": "PHL", "dep_delay": 32, "arr_delay": 22},
   {"origin": "MSY", "dest": "PHL", "dep_delay": null, "arr_delay": null},
   {"origin": "MSY", "dest": "PHL", "dep_delay": -7, "arr_delay": -9},
   {"origin": "PHL", "dest": "RDU", "dep_delay": -7, "arr_delay": -21},
   {"origin": "PHL", "dest": "RDU", "dep_delay": 16, "arr_delay": 2}
];
ScatterX.chart("#app", {
   load_type: "icsr",
   data: data,
   draw_parameter: {
      chart_type: "scatter",
      color: ["origin"],
      x: ["arr_delay"],
      y1: ["dep_delay"]
   }});
1-1-9-1. ICSR Link
데이터를 직접 바인딩하여 사용할 때 예시
// #app
ScatterX.chart("#app", {
   load_type: "icsr",
   data: data,
   draw_parameter: {
      chart_type: "scatter",
      color: ["origin"],
      x: ["arr_delay"],
      y1: ["dep_delay"]
   },
   link_option: [
      {link: "#app-2", transform: "highlight"},
      {link: "#app-3", transform: "visible"}
   ]
});

// #app-2
ScatterX.chart("#app-2", {
   load_type: "icsr",
   data: data,
   draw_parameter: {
      chart_type: "line",
      color: ["origin"],
      x: ["arr_delay"],
      y1: ["dep_delay"]
   }
});

// #app-3
ScatterX.chart("#app-3", {
   load_type: "icsr",
   data: data,
   draw_parameter: {
      chart_type: "bar",
      color: ["origin"],
      x: ["origin"],
      y1: ["dep_delay"]
   }
});
Name Type Required Description
link Selector O 연결할 ICSR 차트가 출력될 선택자
transform String O 연결된 ICSR 차트의 변형을 나타내는 문자열
  • highlight
  • visible
1-2. Draw Parameter
차트를 그릴 때 사용하는 파라미터로 로드 유형이 data_store이거나 db일 때 사용 된다.
var draw_parameter = {
   chart_type: chart_type,
   auto_draw: auto_draw,
   column_count: column_count,
   row_count: row_count,
   // Category
   split: split,
   group: group,
   marker: marker,
   tooltip: tooltip,
   // Legend
   color: color,
   color_aggregation: color_aggregation,
   shape: shape,
   size: size,
   size_aggregation: size_aggregation,
   process: process,
   out_value: out_value,
   in_value: in_value,
   node: node,
   // Value
   x: x,
   xlabel: xlabel,
   from_date: from_date,
   to_date: to_date,
   y1: y1,
   y1_aggregation: y1_aggregation,
   y2: y2,
   y2_aggregation: y2_aggregation,
   y_order: y_order,
   hierarchy: hierarchy,
   bin_count: bin_count,
   label: label,
   value: value,
   value_aggregation: value_aggregation,
   // Priority
   priority: priority,
   // Specific Option
   specific_option: specific_option
};
Name Type Required Description
chart_type String O 차트 유형으로 다음의 값을 사용할 수 있음
  • Scatter
  • Line
  • Bar
  • Boxplot
  • Histogram
  • Pie
  • Wafer
  • Gantt
  • Treemap
  • Heatmap
  • Candle
  • Waterfall
  • Funnel
  • Radar
  • Sankey
  • Edgebundle
  • Wordcloud
  • Network
  • Map
auto_draw Boolean O 차트 API를 호출함과 동시에 차트 그리는 작업을 실행시킬지 여부를 설정하는 값
(기본값 : false)

(*load_type이 icsr일 때 true로 고정됨)
column_count Number O 화면에 출력될 차트의 열 개수
(기본값 : 3)
row_count Number O 화면에 출력될 차트의 행 개수
(기본값 : 3)
split Array X 데이터를 분할하는 기준이 되는 컬럼 설정
group Array X 데이터를 분할하는 기준이 되는 컬럼 설정
marker Array X 데이터를 분할하는 기준이 되는 컬럼 설정
tooltip Array X 툴팁으로 확인할 컬럼을 설정
color Array X 범례의 색상을 나눌 기준이 되는 컬럼 설정
color_aggregation String △ 색상에 적용할 집계함수
(*TreeMap, HeatMap차트일 때)
  • Count
  • UniqueCount
  • Avg
  • Sum
  • StdDev
  • StdDevP
  • Min
  • Max
  • Median
  • Q0
  • Q1
  • Q2
  • Q3
  • Q4
(*Wafer차트일 때)
  • Min
  • Max
shape Array X 도형의 모양을 나눌 기준이 되는 컬럼 설정
size Array X 포인트 크기를 나눌 기준이 되는 컬럼 설정
size_aggregation String △ (*TreeMap 차트일 때)
크기에 적용할 집계함수
  • Count
  • UniqueCount
  • Avg
  • Sum
  • StdDev
  • StdDevP
  • Min
  • Max
  • Median
  • Q0
  • Q1
  • Q2
  • Q3
  • Q4
process Array O (*Sankey 차트일 때)
범례의 색상을 나눌 기준이 되는 컬럼 설정(2개 이상)
out_value Array O (*edgebundle 차트일 때)
범례의 색상을 나눌 기준이 되는 컬럼 설정(나가는 값)
in_value Array O (*edgebundle 차트일 때)
범례의 색상을 나눌 기준이 되는 컬럼 설정(들어오는 값)
node Array O (*network 차트일 때)
범례의 색상을 나눌 기준이 되는 컬럼 설정
x Array O 차트의 x 값을 결정하는 컬럼 설정
xlabel Array △ (*Scatter, Line 차트일 때)
차트의 xlabel 값을 결정하는 컬럼 설정

(*X 값이 String 일 경우, Line 차트에서 Type이 None일 경우에만 적용 가능)
from_date Array O (*Gantt 차트일 때)
차트의 시작 날짜 값을 결정하는 컬럼 설정
to_date Array O (*Gantt 차트일 때)
차트의 끝 날짜 값을 결정하는 컬럼 설정
y1 Array O 차트의 y1 값을 결정하는 컬럼 설정
y1_aggregation String △ (*Bar, Pie, Funnel 차트일 때)
y1에 적용할 집계함수
  • Count
  • UniqueCount
  • Avg
  • Sum
  • StdDev
  • StdDevP
  • Min
  • Max
  • Median
  • Q0
  • Q1
  • Q2
  • Q3
  • Q4
y2 Array X 차트의 y2 값을 결정하는 컬럼 설정
y2_aggregation String △ (*Bar > Combination Chart 차트일 때)
y2에 적용할 집계함수
  • Count
  • UniqueCount
  • Avg
  • Sum
  • StdDev
  • StdDevP
  • Min
  • Max
  • Median
  • Q0
  • Q1
  • Q2
  • Q3
  • Q4
y_order Array X (*Gantt 차트일 때)
차트의 y축의 정렬을 결정하는 컬럼 설정

(*y 값이 String 일 경우에만 적용 가능)
hierarchy Array O (*TreeMap 차트일 때)
차트의 hierarchy 값을 결정하는 컬럼 설정
bin_count Array △ (*Histogram 차트일 때)
차트의 bin count 값을 결정하는 컬럼 설정
label Array O (*radar 차트일 때)
차트의 label 값을 결정하는 컬럼 설정
value Array O (*radar, edgebundle, wordcloud, network 차트일 때)
차트의 value 값을 결정하는 컬럼 설정
value_aggregation String △ (*radar, edgebundle, wordcloud, network 차트일 때)
value에 적용할 집계함수
  • Count
  • UniqueCount
  • Avg
  • Sum
  • StdDev
  • StdDevP
  • Min
  • Max
  • Median
  • Q0
  • Q1
  • Q2
  • Q3
  • Q4
priority Number X 작업 우선순위 설정
(*255 ~ 251)
specific_option Object X 차트 별 세부 설정
1-2-1. Draw Parameter Example
data_store를 사용할 때 일반적인 draw_parameter 설정 예시
(*load_type이 job_id일 때 사용할 수 없음)
ScatterX.chart("#app", {
   load_type: "data_store",
   table_name: "store.DATA_20210430_154906_233",
   draw_parameter: {
      chart_type: "line",
      auto_draw: true,
      column_count: 4,
      row_count: 2,
      split: ["dest"],
      color: ["op_unique_carrier"],
      x: ["fl_date"],
      y1: ["dep_delay"]
   }
});
1-3. Specific Option
차트를 그릴 때 차트 별 세부 설정으로 사용 된다.
(*load_type이 job_id일 때 사용할 수 없음)
var specific_option = {
   // Scatter
   scatter: {
      regression_line: false,
      category_value_of_column: false,
      legend_value_of_column: false
   },
   // Line
   line: {
      type: "None",
      area: false,
      visible_point: false,
      category_value_of_column: false,
      legend_value_of_column: false
   },
   // Bar
   bar: {
      type: "Slide",
      horizontal: false,
      combination_chart: false,
      category_value_of_column: false,
      category_value_of_column_aggregation: "Avg",
      legend_value_of_column: false
      legend_value_of_column_aggregation: "Avg"
   },
   // Boxplot
   boxplot: {
      type: "None",
      horizontal: false,
      category_value_of_column: false
   },
   // Histogram
   histogram: {
      multi_axis: false,
      curve_line: false,
      category_value_of_column: false
   },
   // Pie
   pie: {
      type: "None",
      category_value_of_column: false
      category_value_of_column_aggregation: "Avg"
   },
   // Wafer
   wafer: {
      type: "2D",
   },
   // Gantt
   gantt: {
      category_value_of_column: false
   },
   // Heatmap
   heatmap: {
      category_value_of_column: false,
      box_border: true
   },
   // Candle
   candle: {
      horizontal: false,
      category_value_of_column: false
   },
   // Waterfall
   waterfall: {
      horizontal: false,
      category_value_of_column: false
   },
   // Funnel
   funnel: {
      horizontal: false,
      broken_line: true
   },
   // Radar
   radar: {
      category_value_of_column: false,
      category_value_of_column_aggregation: "Avg",
      legend_value_of_column: false
      legend_value_of_column_aggregation: "Avg"
   },
   // Edgebundle
   edgebundle: {
      tension: 0.85
   }
   // Map
   map: {
      type: "KOR_LEVEL1",
      fill_color: false,
      visible_label: false
   }
};
Name Type Required Description
regression_line Boolean X (*chart_type이 scatter일 때)
X, Y 값이 Number일 때 회귀선 기능의 사용 여부를 나타내는 값
category_value_of_column Boolean X 열 값의 이름을 차트 분할 기준으로 사용할지 여부를 나타내는 값
(*사용 시 Y 값 선택 불가)

사용 가능한 차트 유형
  • Scatter
  • Line
  • Bar
  • Boxplot
  • Histogram
  • Pie
  • Gantt
  • Heatmap
  • Candle
  • Waterfall
  • Radar
category_value_of_column_aggregation String X 열 값의 이름을 차트 분할 기준으로 사용할 때 적용할 집계함수를 나타내는 문자열

사용 가능한 차트 유형
  • Bar
  • Pie
  • Radar
사용 가능한 집계함수
  • Count
  • UniqueCount
  • Avg
  • Sum
  • StdDev
  • StdDevP
  • Min
  • Max
  • Median
  • Q0
  • Q1
  • Q2
  • Q3
  • Q4
legend_value_of_column Boolean X 열 값의 이름을 범례 색상 기준으로 사용할지 여부를 나타내는 값
(*사용 시 Y 값 선택 불가)

사용 가능한 차트 유형
  • Scatter
  • Line
  • Bar
  • Radar
legend_value_of_column_aggregation String X 열 값의 이름을 범례 색상 기준으로 사용할 때 적용할 집계함수를 나타내는 문자열

사용 가능한 차트 유형
  • Bar
  • Radar
사용 가능한 집계함수
  • Count
  • UniqueCount
  • Avg
  • Sum
  • StdDev
  • StdDevP
  • Min
  • Max
  • Median
  • Q0
  • Q1
  • Q2
  • Q3
  • Q4
type String X 차트의 세부 유형을 나타내는 값

Line
  • None
  • ECDF
  • NCDF
  • Probability
Bar
  • Slide
  • Stack
  • Stack100
Boxplot
  • None
  • Dot
Pie
  • None
  • Doughnut
  • Pie3D
  • Sunburst
Wafer
  • 2D
  • 3D
  • Contour
  • Defect
Map
  • CHN_LEVEL1
  • CHN_LEVEL2
  • CHN_LEVEL3
  • JPN_LEVEL1
  • JPN_LEVEL2
  • KOR_LEVEL1
  • KOR_LEVEL2
  • KOR_LEVEL3
  • KOR_LEVEL4
  • US_LEVEL1
  • US_LEVEL2
  • WORLD
area Boolean X (*chart_type이 line일 때)
꺾은 선형 차트에 영역을 색상으로 표시할지 여부를 나타내는 값
visible_point Boolean X (*chart_type이 line일 때)
선에 포인트를 표시할지 여부를 나타내는 값
horizontal Boolean X 차트를 수평으로 표시할지 여부를 나타내는 값

사용 가능한 차트 유형
  • Bar
  • Boxplot
  • Candle
  • Waterfall
  • Funnel
combination_chart Boolean X (*chart_type이 bar일 때)
막대 차트에 꺾은 선을 표시할지 여부를 나타내는 값
(*Y2 값 필요)
multi_axis Boolean X (*chart_type이 histogram일 때)
다중 축 설정을 사용할지 여부를 나타내는 값
curve_line Boolean X (*chart_type이 histogram일 때)
히스토그램 차트에 곡선을 표시할지 여부를 나타내는 값
broken_line Boolean X 차트를 꺾인 선으로 표시할지 여부를 나타내는 값

사용 가능한 차트 유형
  • Funnel
tension Numeric X In/Out Value Item간의 선의 곡선을 결정하는 값

사용 가능한 차트 유형
  • Edgebundle
fill_color Boolean X (*chart_type이 map일 때)
지도 차트에 색상으로 영역을 채울지 여부를 나타내는 값
visible_label Boolean X (*chart_type이 map일 때)
지도 차트에 라벨을 표시할지 여부를 나타내는 값
1-3-1. Specific Option Example
data_store를 사용할 때 일반적인 specific_option 설정 예시
(*load_type이 job_id일 때 사용할 수 없음)
ScatterX.chart("#app", {
   load_type: "data_store",
   table_name: "store.DATA_20210430_154906_233",
   draw_parameter: {
      chart_type: "bar",
      auto_draw: true,
      column_count: 4,
      row_count: 2,
      split: ["dest"],
      color: ["origin"],
      x: ["op_unique_carrier"],
      y1: ["dep_delay"],
      specific_option: {
         bar: {
            type: "Stack",
            horizontal: true
         }
      }
   }
});
1-4. Filter
차트를 그릴 때 사용하는 필터로 로드 유형이 data_store이거나 db일 때 사용 된다.
var filter = [
   // Number & Timestamp
   {column: column, min_value: min_value, max_value: max_value, is_null: is_null, is_range_reverse: is_range_reverse},
   // String
   {column: column, checked_value: checked_value, is_null: is_null}
]
Name Type Required Description
column String O 필터 조건을 설정할 컬럼명
min_value Number △ (*컬럼 타입이 Number / Timestamp일 때)
필터 조건의 최소값을 나타내는 숫자
max_value Number △ (*컬럼 타입이 Number / Timestamp일 때)
필터 조건의 최대값을 나타내는 숫자
checked_value Array △ (*컬럼 타입이 String일 때)
필터 조건의 값을 나타내는 문자 배열
is_null Boolean △ 필터 조건의 null 포함 여부를 나타내는 값
(*기본값 : true)
is_range_reverse Boolean △ (*컬럼 타입이 Number / Timestamp일 때)
필터 조건의 범위 반전 여부를 나타내는 값
(*기본값 : false)
1-4-1. Filter Example
data_store를 사용할 때 일반적인 filter 설정 예시
(*load_type이 job_id일 때 사용할 수 없음)
ScatterX.chart("#app", {
   load_type: "data_store",
   table_name: "store.DATA_20210430_154906_233",
   draw_parameter: {
      chart_type: "scatter",
      auto_draw: true,
      column_count: 4,
      row_count: 2,
      split: ["dest"],
      color: ["op_unique_carrier"],
      x: ["fl_date"],
      y1: ["dep_delay"]
   },
   filter: [
      // Number
      {column: "day_of_month", min_value: 13, max_value: 31, is_null: true, is_range_reverse: false},
      // Timestamp
      {column: "fl_date", min_value: 1483196400000, max_value: 1484931706000, is_null: true, is_range_reverse: false},
      // String
      {column: "op_unique_carrier", checked_value: ["AA","AS","B6","DL","EV","F9","HA"], is_null: true}
   ]
});
1-5. Initial Filter
차트를 그리기 전 미리 설정되는 필터로 로드 유형이 data_store이거나 db일 때 사용 된다.
Filter 속성과 같이 사용할 수 있으며, 이 때 적용되는 Filter는 Initial Filter 조건이 적용된 결과에 바인딩 된다.
var initial_filter = [
   // Number & Timestamp
   {column: column, min_value: min_value, max_value: max_value, is_null: is_null, is_range_reverse: is_range_reverse},
   // String
   {column: column, checked_value: checked_value, is_null: is_null}
]
Name Type Required Description
column String O 필터 조건을 설정할 컬럼명
min_value Number △ (*컬럼 타입이 Number / Timestamp일 때)
필터 조건의 최소값을 나타내는 숫자
max_value Number △ (*컬럼 타입이 Number / Timestamp일 때)
필터 조건의 최대값을 나타내는 숫자
checked_value Array △ (*컬럼 타입이 String일 때)
필터 조건의 값을 나타내는 문자 배열
is_null Boolean △ 필터 조건의 null 포함 여부를 나타내는 값
(*기본값 : true)
is_range_reverse Boolean △ (*컬럼 타입이 Number / Timestamp일 때)
필터 조건의 범위 반전 여부를 나타내는 값
(*기본값 : false)
1-5-1. Initial Filter Example
data_store를 사용할 때 일반적인 initial_filter 설정 예시
(*load_type이 job_id일 때 사용할 수 없음)
ScatterX.chart("#app", {
   load_type: "data_store",
   table_name: "store.DATA_20210430_154906_233",
   draw_parameter: {
      chart_type: "scatter",
      auto_draw: true,
      column_count: 4,
      row_count: 2,
      split: ["dest"],
      color: ["op_unique_carrier"],
      x: ["fl_date"],
      y1: ["dep_delay"]
   },
   filter: [
      {column: "day_of_month", min_value: 13, max_value: 31, is_null: true, is_range_reverse: false},
      {column: "fl_date", min_value: 1483196400000, max_value: 1484931706000, is_null: true, is_range_reverse: false},
      {column: "op_unique_carrier", checked_value: ["AA","AS","B6","DL","EV","F9","HA"], is_null: true}
   ],
   initial_filter: [
      {column: "diverted", min_value: 0, max_value: 0, is_null: true},
      {column: "dest", checked_value: ["ABE","ABI","ABQ","ABR","ABY","ACT","ACY","ADK","ADQ","AEX","AGS","ALB","AMA","ANC","APN"], is_null: true}
   ]
});
1-6. Control Limit
데이터 상한, 하한 및 사건회선, 밴드선 설정을 할 수 있다.
var control_limit = {
   common: common,
   list: list
};
Name Type Required Description
common Object O 공통으로 사용되는 속성
list Array O Control Limit 조건으로 사용되는 설정 배열
1-6-1. Control Limit > Common
공통으로 사용되는 속성으로 영역의 색상 및 표시여부를 설정할 수 있다.
var common = {
   area: area,
   color: color,
   transparent: transparent,
   inout: inout
   is_text_visible: is_text_visible
   font_name: font_name
   font_style: font_style
   font_size: font_size
   font_color: font_color
};
Name Type Required Description
area Boolean O 영역에 색상으로 채울지 여부를 나타내는 값
color String O 영역의 색상을 나타내는 문자열 (RGB값)
transparent Number O 영역의 투명도를 나타내는 숫자 값
(*0 ~ 100)
inout String O 영역의 안쪽 또는 바깥쪽을 채울지 여부를 나타내는 문자열
  • In
  • Out
is_text_visible Boolean O 값이 있을 경우 표시할지 여부를 나타내는 문자열
font_name String O 값의 글꼴 이름을 나타내는 문자열
font_style String O 값의 글꼴 스타일을 나타내는 문자열
  • Regular
  • Bold
  • Italic
  • BoldItalic
font_size String O 값의 글꼴 크기를 나타내는 문자열
font_color String O 값의 글꼴 색상을 나타내는 문자열 (RGB값)
1-6-2. Control Limit > List
Control Limit 조건으로 사용되는 설정을 할 수 있다.
var list = [
   {
      name: name,
      axis: axis,
      column: column,
      column2: column2,
      function: function,
      color: color,
      width: width,
      style: style,
      is_multi: is_multi,
      type: type,
      is_event_line: is_event_line,
      is_each_color: is_each_color,
      regular_expression: regular_expression,
      is_band_line: is_band_line,
      is_interval: is_interval,
      is_reference_line: is_reference_line,
      reference_value: reference_value
   }
];
Name Type Required Description
name String O 조건으로 사용할 이름을 나타내는 문자열
  • 중복, 쌍따옴표는 설정할 수 없음
axis String O (*is_event_line 지원 X)
값의 기준이 되는 축을 나타내는 문자열
column String O (*is_reference_line 지원 X)
조건으로 사용할 컬럼
column2 String △ (*is_band_line 값이 true일 때만 사용)
조건으로 사용할 두 번째 컬럼
function String △ (*None Event일 때만 사용)
스펙을 구하기 위한 집계 함수를 나타내는 문자열
  • avg
  • max
  • median
  • min
color String O 선 색상을 나타내는 문자열 (RGB값)
width Number O 선 두께를 나타내는 숫자
style String O 선 스타일을 나타내는 문자열
  • Solid
  • Dash
  • Dot
is_mulit Boolean O (*None Event일 때만 사용)
스펙을 다중으로 사용할지 여부를 나타내는 값
(구간마다 규격이 다르게 설정)
type String O (*None Event일 때만 사용)
규격을 나태내는 문자열
  • None
  • USL
  • LSL
is_event_line String △ 사건회선 설정여부를 나타내는 값
is_each_color String △ (*is_event_line / is_reference_line 값이 true일 때만 사용)
사건회선의 각 선 색상이 지정되어 있는지 여부를 나타내는 값
regular_expression String △ (*is_event_line 값이 true일 때만 사용)
사건회선에 적용할 정규표현식 조건을 나타내는 문자열
is_band_line Boolean △ 밴드 선이 설정되어 있는지를 나타내는 값
is_interval Boolean △ (*is_band_line 값이 true일 때만 사용)
밴드 선의 영역이 각각 설정되어 있는지를 나타내는 값
is_reference_line Boolean △ 참조 선이 설정되어 있는지를 나타내는 값
reference_value String △ (*is_reference_line 값이 true일 때만 사용)
사용자가 참조 선을 설정하기 위한 값
1-6-3. Control Limit Example
Control Limit을 사용하는 예시 (UCL & LCL, Event Line, Band Line, Reference Line)
var control_limit = {
   common: {
      area: true,
      color: "0,128,0",
      transparent: 80,
      inout: "In"
      is_text_visible: true
      font_name: "Verdana"
      font_style: "Regular"
      font_size: "11"
      font_color: "77,77,77"
   },
   list: [
      // Upper & Lower & Target Limit
      {
         name: "Upper Limit",
         axis: "Left",
         column: "upper_limit",
         function: "avg",
         color: "0,255,0",
         width: 1,
         style: "Solid",
         is_multi: false,
         type: "USL"
      },
      // Event Line
      {
         name: "Event Line",
         axis: "Bottom",
         column: "upper_limit",
         color: "0,0,255",
         width: 1,
         style: "Solid",
         is_event_line: true,
         is_each_color: false,
         regular_expression: "^AA"
      },
      // Band Line
      {
         name: "Band Line",
         axis: "Left",
         column: "upper_limit",
         column2: "lower_limit",
         color: "255,0,0",
         width: 1,
         style: "Solid",
         is_band_line: true,
         is_interval: false
      },
      // Reference Line
      {
         name: "Reference Line",
         axis: "Left",
         color: "255,0,0",
         width: 1,
         style: "Solid",
         is_reference_line: true,
         is_each_color: false,
         reference_value: "100,200"
      }
   ]};
1-7. Update Chart
차트 출력 후 로드 유형 혹은 테이블 설정을 변경할 수 있다.

- 설정할 수 있는 로드 유형
  • Data Store
  • DB
  • Unit
ScatterX.chartUpdate("#app", {
   load_type: "data_store",
   table_name: "store.DATA_20210430_154906_233",
   draw_parameter: {
      auto_draw: true
   }
});
2. ScatterX.API
Scatter Analytics에서 제공하는 기능에 대한 API로 다양한 기능을 JavaScript API를 사용하여 설정할 수 있다.

2-1. API 공통
API는 .help() 를 통해 자세한 설명을 확인 할 수 있도록 제공한다.
또한, .get() 과 .set() 을 사용하여 현재 설정되어 있는 값을 확인하거나, 재설정 할 수 있도록 제공한다.
// 사용 가능한 API를 콘솔에 출력한다.
ScatterX.API.help();
// 특정 API에 대한 자세한 설명을 볼 수 있다.
ScatterX.API.help("chartOption");

// 다른 방법으로도 호출 할 수 있다.
ScatterX.API.chartOption.help();
2-2. Server Origin
타 시스템과 연계 할 때 사용하는 API로 Scatter Analytics를 다른 도메인에서 사용할 때 설정하는 값이다.
ScatterX.API.serverOrigin.get();
ScatterX.API.serverOrigin.set("https://scatterx.scatteranalytics.io");
Name Type Required Description
value String O Server Origin을 나타내는 문자열
2-3. API Key
API 키에 대한 설정을 할 수 있다.
ScatterX.API.key.set("api_key");
Name Type Required Description
value String O API 키
2-4. User
사용자에 대한 설정을 할 수 있다.
ScatterX.API.user.get();
ScatterX.API.user.set(user_id, company_code);
Name Type Required Description
user_id String O 사용자 아이디
company_code String O 회사 코드
사용자 아이디에 대한 설정을 초기화 할 수 있다.
ScatterX.API.user.reset();
2-5. Loader
데이터 적재에 관한 설정으로 아래의 로드 유형으로 데이터를 가져와 Data Store(데이터 스토어)에 적재할 수 있다.
  • DB
  • DB Custom
  • File Path
  • Parquet
2-5-1. Load Type : DB
관리자 페이지에 등록된 데이터소스관리의 데이터소스명으로 데이터를 적재할 때 예시
ScatterX.API.loader.set(value[, callback]);
// Example
ScatterX.API.loader.set({
   load_type: "db",
   db_name: "IOTDB",
   db_query: "select * from iot.sensor_value limit 1000",
   ac_name: "IOT",
   index_definition: ["(column1)", "(column2)"]
}, callback);
Name Type Required Description
load_type String O 로드 유형을 설정하는 값
db_name String O 관리자 페이지에 등록된 데이터소스관리의 데이터소스명
db_query String O 데이터베이스에서 실행할 쿼리
ac_name String △ Data Store에 등록될 이름(아카이브명)
index_definition Array △ 데이터 적재후 생성할 인덱스의 정의
지원 데이터베이스
  • Oracle
  • Greenplum
callback Function △ 콜백을 나타내는 함수
*Argument : Data Table Name
2-5-2. Load Type : DB Custom
JDBC 접속정보를 설정하여 데이터를 가져와 적재할 때 예시
ScatterX.API.loader.set(value[, callback]);
// Example
ScatterX.API.loader.set({
   load_type: "db_custom",
   db_type: "PostgreSQL",
   db_jdbc_url: "jdbc:postgresql://192.168.0.190:5432/iotdb",
   db_jdbc_driver: "org.postgresql.Driver",
   db_user_name: "scatterx.user",
   db_password: "scatterx1234",
   db_query: "select * from iot.sensor_value limit 1000",
   ac_name: "IOT Test Data",
   index_definition: ["(column1)", "(column2)"]
}, callback);
Name Type Required Description
load_type String O 로드 유형을 설정하는 값
db_type String O 데이터베이스 유형
  • Altibase
  • Oracle
  • Greenplum
  • PostgreSQL
db_jdbc_url String O JDBC url
db_jdbc_driver String O JDBC driver
db_user_name String O 데이터베이스 사용자 이름
db_password String O 데이터베이스 사용자 비밀번호
db_query String O 데이터베이스에서 실행할 쿼리
ac_name String △ Data Store에 등록될 이름(아카이브명)
index_definition Array △ 데이터 적재후 생성할 인덱스의 정의
지원 데이터베이스
  • Oracle
  • Greenplum
callback Function △ 콜백을 나타내는 함수
*Argument : Data Table Name
2-5-3. Load Type : File Path
파일 경로에서 데이터를 가져와 적재할 때 예시
ScatterX.API.loader.set(value[, callback]);
// Example
ScatterX.API.loader.set({
   load_type: "file_path",
   file_path: "http://iot.scatteranalytics.io:9080/data/flight/flight_2017.csv.gz",
   alt_data_file_path: ["http://<server>:<port>/<path>"],
   delimiter: ",",
   quote: "\"",
   skip_header: true,
   null_as: "",
   compression: "Gzip",
   ac_name: "Flight Data",
   index_definition: ["(column1)", "(column2)"],
   contents_schema: [
      {name: "year_", type: "integer"},
      {name: "month_", type: "integer"},
      {name: "day_of_month", type: "integer"},
      {name: "day_of_week", type: "integer"},
      {name: "fl_date", type: "timestamp", dateformat: "yyyy-MM-dd HH:mm:ss.SSS"},
      {name: "op_unique_carrier", type: "string"},
      {name: "tail_num", type: "string"},
      {name: "op_carrier_fl_num", type: "integer"},
      {name: "origin", type: "string"},
      {name: "dest", type: "string"},
      {name: "crs_dep_time", type: "integer"},
      {name: "dep_time", type: "integer"},
      {name: "dep_delay", type: "integer"},
      {name: "taxi_out", type: "integer"},
      {name: "taxi_in", type: "integer"},
      {name: "crs_arr_time", type: "integer"},
      {name: "arr_time", type: "integer"},
      {name: "arr_delay", type: "integer"},
      {name: "cancelled", type: "integer"},
      {name: "cancellation_code", type: "string"},
      {name: "diverted", type: "string"},
      {name: "crs_elapsed_time", type: "integer"},
      {name: "actual_elapsed_time", type: "integer"},
      {name: "air_time", type: "integer"},
      {name: "distance", type: "integer"},
      {name: "carrier_delay", type: "integer"},
      {name: "weather_delay", type: "integer"},
      {name: "nas_delay", type: "integer"},
      {name: "security_delay", type: "integer"},
      {name: "late_aircraft_delay", type: "integer"},
      {name: "upper_limit", type: "integer"},
      {name: "target_limit", type: "double"},
      {name: "lower_limit", type: "integer"}
   ]}, callback);
Name Type Required Description
load_type String O 로드 유형을 설정하는 값
file_path String O 파일이 위치한 경로
  • 디렉토리를 사용하면 해당 디렉토리 안에 들어있는 모든 파일을 로드
  • 파일명을 사용하면 해당 파일을 로드
  • file_source_name 옵션을 사용할 경우 관리자 페이지의 데이터소스관리에 등록된 루트(ROOT)경로를 제외한 나머지 경로만 입력해야 함
    • Full path Example → sftp://host.example.com:22/path/file/file.csv
    • Root path Example → sftp://host.example.com:22/path
    • file_path Example → /file.csv
alt_data_file_path String △ file_path 외 추가적인 파일경로
  • sftp를 사용하는 경우 sftp의 주소정보를 제외한 나머지 절대경로를 입력해야 함
    • file_path Example → sftp://host.example.com:22/path/file/file.csv
    • alt_data_file_path Example → /path/file/file.csv
  • hdfs를 사용하는 경우 hdfs 프로토콜을 포함한 전체주소를 입력해야 함
hdfs_proxy_user String X HDFS 프록시 사용자
(기본값 : 사용자 아이디)
file_source_name String △ 관리자 페이지에 등록된 데이터소스관리의 데이터소스명
file_username String △ 파일이 위치한 경로로 접속할 때 사용자 인증을 위한 유저 이름 정보
  • file_source_name옵션이 설정되지 않은 경우에만 사용
file_password String △ 파일이 위치한 경로로 접속할 때 사용자 인증을 위한 유저 패스워드 정보
  • file_source_name옵션이 설정되지 않은 경우에만 사용
s3_accesskey String △ Access key
  • S3 로드일 경우에만 사용
s3_secretkey String △ Secret key
  • S3 로드일 경우에만 사용
s3_endpoint String X 엔드포인트
  • S3 로드일 경우에만 사용
s3_regionname String △ 리전
  • S3 로드일 경우에만 사용
best_effort Boolean X CSV 데이터에 오류가 존재하여도 Skip하여 계속 처리할지의 여부
delimiter String O 구분자
quote String △ 따옴표
skip_header Boolean O 첫 줄의 Header 여부
null_as String △ null 값 정의
suffix String △ 파일의 접미사
encoding String X 파일 인코딩
(기본값 : UTF-8)
compression String △ 압축형태
ac_name String △ Data Store에 등록될 이름(아카이브명)
index_definition Array △ 데이터 적재후 생성할 인덱스의 정의
지원 데이터베이스
  • Oracle
  • Greenplum
contents_schema Array O 데이터의 스키마 정보
callback Function △ 콜백을 나타내는 함수
*Argument : Data Table Name
2-5-4. Load Type : Parquet
해당 HDFS 위치상에 존재하는 데이터를 가져와 적재할 때 예시
(*지정한 파일위치가 디렉토리일 경우 내부 모든 파일이 적재되고 단일파일이면 해당 파일만 적재)
ScatterX.API.loader.set(value[, callback]);
// Example
ScatterX.API.loader.set({
   load_type: "parquet",
   file_path: "hdfs://<server>:<port>/<path>",
   alt_data_file_path: ["hdfs://<server>:<port>/<path>"],
   hdfs_proxy_user: "hadoop",
   timezone: "Asia/Seoul",
   parsing_type: "Single",
   ac_name: "Parquet Data",
   index_definition: ["(column1)", "(column2)"]
}, callback);
Name Type Required Description
load_type String O 로드 유형을 설정하는 값
file_path String O Parquet 파일이 위치한 하둡상의 디렉토리 또는 단일 파일의 경로
alt_data_file_path String △ file_path 외 추가적인 파일경로
hdfs_proxy_user String X 파일시스템에 로그인할 계정명
timezone String △ Parquet의 int96타입을 timestamp 형식으로 변환시 적용할 타임존 이름
  • Asia/Seoul
  • Europe/London
  • UTC(*Default)
    • 더보기
parsing_type String △ 데이터 파서를 멀티서버에서 할 것인지 지정
  • Single(*Default)
  • Multi
ac_name String △ Data Store에 등록될 이름(아카이브명)
index_definition Array △ 데이터 적재후 생성할 인덱스의 정의
지원 데이터베이스
  • Oracle
  • Greenplum
callback Function △ 콜백을 나타내는 함수
*Argument : Data Table Name
2-6. Chart Option
차트 옵션에 관한 설정으로 아래의 설정을 할 수 있다.
  • Title
  • Axes
  • Legend
  • Panel
  • Palette
  • Shape
  • Size
  • Point Label
  • Wafer
  • Value
  • Score
  • Prediction
  • Selection

2-6-1. Chart Option > Title
차트 제목에 관련된 설정을 할 수 있으며 아래의 항목들을 설정할 수 있도록 제공한다.
  • Title
  • Subtitle
2-6-1-1. Chart Option > Title > Title
차트 제목의 각도 및 글꼴에 대한 설정을 할 수 있다.

2-6-1-1-1. Chart Option > Title > Title > Angle
ScatterX.API.chartOption.title.title.angle.get();
ScatterX.API.chartOption.title.title.angle.set(45);
Name Type Required Description
value Number O 각도를 나타내는 숫자
2-6-1-1-2. Chart Option > Title > Title > Font
ScatterX.API.chartOption.title.title.font.name.get();
ScatterX.API.chartOption.title.title.font.name.set("Arial");
Name Type Required Description
value String O 글꼴 이름을 나타내는 문자열
ScatterX.API.chartOption.title.title.font.style.get();
ScatterX.API.chartOption.title.title.font.style.set("bold");
Name Type Required Description
value String O 글꼴 스타일을 나타내는 문자열
  • Regular
  • Bold
  • Italic
  • BoldItalic
ScatterX.API.chartOption.title.title.font.size.get();
ScatterX.API.chartOption.title.title.font.size.set(12);
Name Type Required Description
value Number O 글꼴 크기를 나타내는 숫자
ScatterX.API.chartOption.title.title.font.color.get();
ScatterX.API.chartOption.title.title.font.color.set("255,0,0");
Name Type Required Description
value String O 글꼴 색상을 나타내는 문자열 (RGB값)
2-6-1-2. Chart Option > Title > Subtitle
* Chart Option > Title > Title과 동일한 방식으로 사용할 수 있다.
ScatterX.API.chartOption.title.subtitle.angle.get();
2-6-1-3. Chart Option > Title > Concat String
Split 설정을 하였을 때 사용되는 값으로, 차트 제목에서 사용되는 구분 문자열을 설정할 수 있다.
ScatterX.API.chartOption.title.concatString.get();
ScatterX.API.chartOption.title.concatString.set("_");
Name Type Required Description
value String O 텍스트 구분을 나타내는 문자열
2-6-2. Chart Option > Axes
차트 축 설정을 할 수 있는 API로 y1축(좌측), y2축(우측), x축(하단)에 대한 서식을 정할 수 있다.
  • Left
  • Right
  • Bottom
2-6-2-1. Chart Option > Axes > Left
y1축(좌측)에 대한 상세 설정을 할 수 있다.
  • Visible
  • Title
  • Value
  • Grid
  • Tick
  • Label
2-6-2-1-1. Chart Option > Axes > Left > Visible
ScatterX.API.chartOption.axes.left.visible.get();
ScatterX.API.chartOption.axes.left.visible.set(false);
Name Type Required Description
value Boolean O 축 표시 여부를 나타내는 값
2-6-2-1-2. Chart Option > Axes > Left > Title
축 제목에 대한 설정으로 표시 여부, 텍스트, 각도, 글꼴을 설정할 수 있다.
  • Visible
  • Text
  • Angle
  • Font
2-6-2-1-2-1. Chart Option > Axes > Left > Title > Visible
ScatterX.API.chartOption.axes.left.title.visible.get();
ScatterX.API.chartOption.axes.left.title.visible.set(false);
Name Type Required Description
value Boolean O 축 제목을 표시할지 여부를 나타내는 값
2-6-2-1-2-2. Chart Option > Axes > Left > Title > Text
ScatterX.API.chartOption.axes.left.title.text.get();
ScatterX.API.chartOption.axes.left.title.text.set("Custom Y Axis");
Name Type Required Description
value String X 축 제목을 나타내는 문자열로 설정하지 않거나 빈 문자열을 설정하면 자동으로 데이터의 컬럼명을 사용
(기본값: "")
2-6-2-1-2-3. Chart Option > Axes > Left > Title > Angle
ScatterX.API.chartOption.axes.left.title.angle.get();
ScatterX.API.chartOption.axes.left.title.angle.set(30);
Name Type Required Description
value Number O 각도를 나타내는 숫자
2-6-2-1-2-4. Chart Option > Axes > Left > Title > Font
ScatterX.API.chartOption.axes.left.title.font.name.get();
ScatterX.API.chartOption.axes.left.title.font.name.set("궁서체");
Name Type Required Description
value String O 글꼴 이름을 나타내는 문자열
ScatterX.API.chartOption.axes.left.title.font.style.get();
ScatterX.API.chartOption.axes.left.title.font.style.set("italic");
Name Type Required Description
value String O 글꼴 스타일을 나타내는 문자열
  • Regular
  • Bold
  • Italic
  • BoldItalic
ScatterX.API.chartOption.axes.left.title.font.size.get();
// 글꼴 크기만 변경할 때
ScatterX.API.chartOption.axes.left.title.font.size.set(11);

// 글꼴 크기 변경과 동시에 글꼴 크기 자동 설정을 해제할 때
ScatterX.API.chartOption.axes.left.title.font.size.set(11, true);
Name Type Required Description
value Number O 글꼴 크기를 나타내는 숫자
disableAutoSize Boolean X 글꼴 크기 자동 설정 해제를 나타내는 값
(기본값 : false)
ScatterX.API.chartOption.axes.left.title.font.color.get();
ScatterX.API.chartOption.axes.left.title.font.color.set("0,0,255");
Name Type Required Description
value String O 글꼴 색상을 나타내는 문자열 (RGB값)
2-6-2-1-3. Chart Option > Axes > Left > Value
축의 최소 & 최대값을 설정할 수 있다.
  • Auto
  • Log
  • Min
  • Max
2-6-2-1-3-1. Chart Option > Axes > Left > Value > Auto
ScatterX.API.chartOption.axes.left.value.auto.get();
ScatterX.API.chartOption.axes.left.value.auto.set(false);
Name Type Required Description
value Boolean O 축의 최소 & 최대값을 자동으로 설정할지 여부를 결정하는 값
2-6-2-1-3-2. Chart Option > Axes > Left > Value > Log
ScatterX.API.chartOption.axes.left.value.log.get();
ScatterX.API.chartOption.axes.left.value.log.set(false);
Name Type Required Description
value Boolean O 축에 Log를 사용할지 여부를 결정하는 값
2-6-2-1-3-3. Chart Option > Axes > Left > Value > Min
ScatterX.API.chartOption.axes.left.value.min.auto.get();
ScatterX.API.chartOption.axes.left.value.min.auto.set(false);
Name Type Required Description
value Boolean O 축의 최소값을 자동으로 사용할지 여부를 결정하는 값
ScatterX.API.chartOption.axes.left.value.min.value.get();
ScatterX.API.chartOption.axes.left.value.min.value.set(0);
Name Type Required Description
value Number X 축의 최소값으로 사용할 숫자
2-6-2-1-3-4. Chart Option > Axes > Left > Value > Max
ScatterX.API.chartOption.axes.left.value.max.auto.get();
ScatterX.API.chartOption.axes.left.value.max.auto.set(true);
Name Type Required Description
value Boolean O 축의 최대값을 자동으로 사용할지 여부를 결정하는 값
ScatterX.API.chartOption.axes.left.value.max.value.get();
ScatterX.API.chartOption.axes.left.value.max.value.set(100);
Name Type Required Description
value Number X 축의 최대값으로 사용할 숫자
2-6-2-1-4. Chart Option > Axes > Left > Line
축에 대한 선을 설정하는 API로 아래의 항목을 설정할 수 있다.
  • Visible
  • Width
  • Color
2-6-2-1-4-1. Chart Option > Axes > Left > Line > Visible
ScatterX.API.chartOption.axes.left.line.visible.get();
ScatterX.API.chartOption.axes.left.line.visible.set(false);
Name Type Required Description
value Boolean O 축의 선을 표시할지 여부를 결정하는 값
2-6-2-1-4-2. Chart Option > Axes > Left > Line > Width
ScatterX.API.chartOption.axes.left.line.width.get();
ScatterX.API.chartOption.axes.left.line.width.set(1);
Name Type Required Description
value Number O 축의 선 두께를 결정하는 값
2-6-2-1-4-3. Chart Option > Axes > Left > Line > Color
ScatterX.API.chartOption.axes.left.line.color.get();
ScatterX.API.chartOption.axes.left.line.color.set("128,128,128");
Name Type Required Description
value String O 축의 선 색깔을 결정하는 값
2-6-2-1-5. Chart Option > Axes > Left > Grid
축에 대한 그리드를 설정하는 API로 아래의 항목을 설정할 수 있다.
  • Visible
  • Width
  • Distance
2-6-2-1-5-1. Chart Option > Axes > Left > Grid > Visible
ScatterX.API.chartOption.axes.left.grid.visible.get();
ScatterX.API.chartOption.axes.left.grid.visible.set(false);
Name Type Required Description
value Boolean O 그리드를 표시할지 여부를 결정하는 값
2-6-2-1-5-2. Chart Option > Axes > Left > Grid > Width
ScatterX.API.chartOption.axes.left.grid.width.get();
ScatterX.API.chartOption.axes.left.grid.width.set(2);
Name Type Required Description
value Number O 그리드 선 두께를 나타내는 숫자
2-6-2-1-5-3. Chart Option > Axes > Left > Grid > Distance
ScatterX.API.chartOption.axes.left.grid.distance.get();
ScatterX.API.chartOption.axes.left.grid.distance.set(2);
Name Type Required Description
value Number O 그리드 간 거리를 나타내는 숫자
2-6-2-1-5-4. Chart Option > Axes > Left > Grid > Color
ScatterX.API.chartOption.axes.left.grid.color.get();
ScatterX.API.chartOption.axes.left.grid.color.set("128,128,128");
Name Type Required Description
value String O 그리드 색상을 나타내는 문자열 (RGB값)
2-6-2-1-6. Chart Option > Axes > Left > Tick
축 눈금을 설정하는 API로 아래의 설정을 할 수 있다.
  • Visible
  • Count
  • Length
  • Width
  • Color
2-6-2-1-6-1. Chart Option > Axes > Left > Tick > Visible
ScatterX.API.chartOption.axes.left.tick.visible.get();
ScatterX.API.chartOption.axes.left.tick.visible.set(false);
Name Type Required Description
value Boolean O 축 눈금을 표시할지 여부를 나타내는 값
2-6-2-1-6-2. Chart Option > Axes > Left > Tick > Count
ScatterX.API.chartOption.axes.left.tick.count.get();
ScatterX.API.chartOption.axes.left.tick.count.set(10);
Name Type Required Description
value Number O 눈금 개수를 나타내는 숫자
2-6-2-1-6-3. Chart Option > Axes > Left > Tick > Length
ScatterX.API.chartOption.axes.left.tick.length.get();
ScatterX.API.chartOption.axes.left.tick.length.set(3);
Name Type Required Description
value Number O 눈금 길이를 나타내는 숫자
2-6-2-1-6-4. Chart Option > Axes > Left > Tick > Width
ScatterX.API.chartOption.axes.left.tick.width.get();
ScatterX.API.chartOption.axes.left.tick.width.set(2);
Name Type Required Description
value Number O 눈금 선 두께를 나타내는 숫자
2-6-2-1-6-5. Chart Option > Axes > Left > Tick > Color
ScatterX.API.chartOption.axes.left.tick.color.get();
ScatterX.API.chartOption.axes.left.tick.color.set("128,128,128");
Name Type Required Description
value String O 눈금 색상을 나타내는 문자열 (RGB값)
2-6-2-1-7. Chart Option > Axes > Left > Label
축 라벨에 대한 설정으로 아래의 항목들을 정할 수 있다.
  • Visible
  • Angle
  • Font
  • Format
  • Auto
  • Length
  • Visual Min Size
  • Lable Max Visible
  • Hierarcy Text
2-6-2-1-7-1. Chart Option > Axes > Left > Label > Visible
ScatterX.API.chartOption.axes.left.label.visible.get();
ScatterX.API.chartOption.axes.left.label.visible.set(false);
Name Type Required Description
value Boolean O 축 라벨의 표시 여부를 나타내는 값
2-6-2-1-7-2. Chart Option > Axes > Left > Label > Angle
ScatterX.API.chartOption.axes.left.label.angle.get();
ScatterX.API.chartOption.axes.left.label.angle.set(45);
Name Type Required Description
value Number O 축 라벨의 각도를 나타내는 숫자
2-6-2-1-7-3. Chart Option > Axes > Left > Label > Font
ScatterX.API.chartOption.axes.left.label.font.name.get();
ScatterX.API.chartOption.axes.left.label.font.name.set("Arial");
Name Type Required Description
value String O 글꼴 이름을 나타내는 문자열
ScatterX.API.chartOption.axes.left.label.font.style.get();
ScatterX.API.chartOption.axes.left.label.font.style.set("bold");
Name Type Required Description
value String O 글꼴 스타일을 나타내는 문자열
  • Regular
  • Bold
  • Italic
  • BoldItalic
ScatterX.API.chartOption.axes.left.label.font.size.get();
// 글꼴 크기만 변경할 때
ScatterX.API.chartOption.axes.left.label.font.size.set(15);

// 글꼴 크기 변경과 동시에 글꼴 크기 자동 설정을 해제할 때
ScatterX.API.chartOption.axes.left.label.font.size.set(15, true);
Name Type Required Description
value Number O 글꼴 크기를 나타내는 숫자
disableAutoSize Boolean X 글꼴 크기 자동 설정 해제를 나타내는 값
(기본값 : false)
ScatterX.API.chartOption.axes.left.label.font.color.get();
ScatterX.API.chartOption.axes.left.label.font.color.set("0,0,0");
Name Type Required Description
value String O 글꼴 색상을 나타내는 문자열 (RGB값)
2-6-2-1-7-4. Chart Option > Axes > Left > Label > Format
ScatterX.API.chartOption.axes.left.label.format.numeric.get();
ScatterX.API.chartOption.axes.left.label.format.numeric.set("#,##0.#");
Name Type Required Description
value String O 숫자 형식을 나타내는 문자열
ScatterX.API.chartOption.axes.left.label.format.dateTime.get();
ScatterX.API.chartOption.axes.left.label.format.dateTime.set("yyyy-MM-dd");
Name Type Required Description
value String O 날짜 형식을 나타내는 문자열
2-6-2-1-7-5. Chart Option > Axes > Left > Label > Auto
ScatterX.API.chartOption.axes.left.label.auto.get();
ScatterX.API.chartOption.axes.left.label.auto.set(true);
Name Type Required Description
value Boolean O 축 라벨 길이를 자동으로 설정할지를 나타내는 값
2-6-2-1-7-6. Chart Option > Axes > Left > Label > Length
ScatterX.API.chartOption.axes.left.label.length.get();
ScatterX.API.chartOption.axes.left.label.length.set(115);
Name Type Required Description
value Number O 축 라벨 길이를 나타내는 숫자
2-6-2-1-7-7. Chart Option > Axes > Left > Label > Visual Min Size
ScatterX.API.chartOption.axes.left.label.visualMinSize.get();
ScatterX.API.chartOption.axes.left.label.visualMinSize.set(115);
Name Type Required Description
value Number O 축 라벨의 최소 길이를 나타내는 숫자
2-6-2-1-7-8. Chart Option > Axes > Left > Label > Lable Max Visible
ScatterX.API.chartOption.axes.left.label.maxVisible.get();
ScatterX.API.chartOption.axes.left.label.maxVisible.set(false);
Name Type Required Description
value Boolean O 축 라벨의 개수를 최대로 할지 여부를 나탸내는 값
2-6-2-1-7-9. Chart Option > Axes > Left > Label > Hierarcy Text
ScatterX.API.chartOption.axes.left.label.hierarcyText.get();
ScatterX.API.chartOption.axes.left.label.hierarcyText.set(true);
Name Type Required Description
value Boolean O 축 라벨의 계층형 설정 여부를 나탸내는 값
2-6-2-2. Chart Option > Axes > Right
* Chart Option > Axes > Left와 동일한 방식으로 사용할 수 있다.
ScatterX.API.chartOption.axes.right.visible.get();
2-6-2-2-1. Chart Option > Axes > Right > Axis Synchronization
y2축(우측)에만 설정할 수 있는 속성으로 축 동기화 설정 할 때 사용한다.
ScatterX.API.chartOption.axes.right.synchronization.get();
ScatterX.API.chartOption.axes.right.synchronization.set(false);
Name Type Required Description
value Boolean O Y2축을 동기화 할지 여부를 나탸내는 값
2-6-2-3. Chart Option > Axes > Bottom
* Chart Option > Axes > Right와 동일한 방식으로 사용할 수 있다.
ScatterX.API.chartOption.axes.bottom.visible.get();
2-6-2-3-1. Chart Option > Axes > Bottom > Multi Axis
x축(하단)에만 설정할 수 있는 속성으로 다중 축 설정 할 때 사용한다.
  • Line
  • Text
ScatterX.API.chartOption.axes.bottom.multiAxis.line.get();
ScatterX.API.chartOption.axes.bottom.multiAxis.line.set(true);
Name Type Required Description
value Boolean O 다중 축 선을 사용할지 여부를 나타내는 값
ScatterX.API.chartOption.axes.bottom.multiAxis.text.get();
ScatterX.API.chartOption.axes.bottom.multiAxis.text.set(true);
Name Type Required Description
value Boolean O 다중 축 선을 사용할 때 라벨을 표시 여부를 나타내는 값
2-6-3. Chart Option > Legend
차트 범례에 대한 설정을 할 수 있다.
  • Legend
  • Change
2-6-3-1. Chart Option > Legend
차트 범례를 설정하는 API로 아래의 항목들을 정할 수 있다.
  • Visible
  • Event Line
  • Reverse
  • Size
  • Position
  • Font
  • Align
2-6-3-1-1. Chart Option > Legend > Visible
범례 표시 여부를 설정할 수 있다.
ScatterX.API.chartOption.legend.visible.get();
ScatterX.API.chartOption.legend.visible.set(false);
Name Type Required Description
value Boolean O 범례 표시여부를 나타내는 값
2-6-3-1-2. Chart Option > Legend > Border Visible
범례의 테두리 선 여부를 설정할 수 있다.
ScatterX.API.chartOption.legend.borderVisible.get();
ScatterX.API.chartOption.legend.borderVisible.set(false);
Name Type Required Description
value Boolean O 범례 테두리 선 여부를 나타내는 값
2-6-3-1-3. Chart Option > Legend > Event Line
Control Limit 기능에서 설정한 Event Line을 범례 항목으로 표시할지 여부를 설정할 수 있다.
ScatterX.API.chartOption.legend.eventLine.get();
ScatterX.API.chartOption.legend.eventLine.set(true);
Name Type Required Description
value Boolean O Event Line 표시 여부를 나타내는 값
2-6-3-1-4. Chart Option > Legend > Reverse
범례 순서를 역순으로 표시할지 여부를 설정할 수 있다.
  • Scatter
  • Line
  • Bar
  • Boxplot
  • Pie (Sub Type Sunburst 제외)
ScatterX.API.chartOption.legend.reverse.get();
ScatterX.API.chartOption.legend.reverse.set(true);
Name Type Required Description
value Boolean O 역순으로 표시할지 여부를 나타내는 값
2-6-3-1-5. Chart Option > Legend > Size
범례의 크기를 설정할 수 있다.
ScatterX.API.chartOption.legend.size.auto.get();
ScatterX.API.chartOption.legend.size.auto.set(true);
Name Type Required Description
value Boolean O 범례 크기를 자동으로 설정할지 여부를 나타내는 값
ScatterX.API.chartOption.legend.size.value.get();
ScatterX.API.chartOption.legend.size.value.set(150);
Name Type Required Description
value Number O 범례 크기를 나타내는 숫자
2-6-3-1-6. Chart Option > Legend > Position
범례 위치를 설정할 수 있다.
ScatterX.API.chartOption.legend.position.get();
ScatterX.API.chartOption.legend.position.set("top");
Name Type Required Description
value String O 범례 위치를 나타내는 문자열
  • top
  • right
  • bottom
  • left
2-6-3-1-7. Chart Option > Legend > Font
범례 글꼴을 설정할 수 있다.
ScatterX.API.chartOption.legend.font.name.get();
ScatterX.API.chartOption.legend.font.name.set("Arial");
Name Type Required Description
value String O 글꼴 이름을 나타내는 문자열
ScatterX.API.chartOption.legend.font.style.get();
ScatterX.API.chartOption.legend.font.style.set("bold");
Name Type Required Description
value String O 글꼴 스타일을 나타내는 문자열
  • Regular
  • Bold
  • Italic
  • BoldItalic
ScatterX.API.chartOption.legend.font.size.get();
ScatterX.API.chartOption.legend.font.size.set(15);
Name Type Required Description
value Number O 글꼴 크기를 나타내는 숫자
ScatterX.API.chartOption.legend.font.color.get();
ScatterX.API.chartOption.legend.font.color.set("128,128,128");
Name Type Required Description
value String O 글꼴 색상을 나타내는 문자열 (RGB값)
2-6-3-1-8. Chart Option > Legend > Align
범례 항목의 순서를 설정할 수 있다.

2-6-3-1-8-1. Chart Option > Legend > Align > Natural
ScatterX.API.chartOption.legend.align.natural.get();
ScatterX.API.chartOption.legend.align.natural.set(true);
Name Type Required Description
value Boolean O 자연 정렬을 사용할지 여부를 나타내는 값
2-6-3-1-8-2. Chart Option > Legend > Align > Reg Exp
ScatterX.API.chartOption.legend.align.regExp.get();
ScatterX.API.chartOption.legend.align.regExp.set(true);
Name Type Required Description
value Boolean O 정규식 표현을 사용할지 여부를 나타내는 값
2-6-3-1-8-3. Chart Option > Legend > Align > Custom
ScatterX.API.chartOption.legend.align.custom.get();
// 정규식 사용할 때 (U로 시작하는 항목을 우선 배치)
ScatterX.API.chartOption.legend.align.custom.set("^U");
// 정규식 사용하지 않을 때 (콤마 구분자로 값 입력)
ScatterX.API.chartOption.legend.align.custom.set("B6,DL,EV,F9");
Name Type Required Description
value String O 정규식을 사용할 때는 정규식 표현을 나타내는 문자열
정규식을 사용하지 않을 때는 특정 값을 나타내는 문자열
2-6-3-1-8-3-1. Chart Option > Legend > Align > Custom > Bottom
ScatterX.API.chartOption.legend.align.custom.bottom.get();
// 정규식 사용할 때 (U로 시작하는 항목을 우선 배치)
ScatterX.API.chartOption.legend.align.custom.bottom.set("^U");
// 정규식 사용하지 않을 때 (콤마 구분자로 값 입력)
ScatterX.API.chartOption.legend.align.custom.bottom.set("B6,DL,EV,F9");
Name Type Required Description
value String O 정규식을 사용할 때는 정규식 표현을 나타내는 문자열
정규식을 사용하지 않을 때는 특정 값을 나타내는 문자열
2-6-3-1-8-4. Chart Option > Legend > Align > Value
(*Bar Chart일 경우에만 지원)
ScatterX.API.chartOption.legend.align.value.get();
ScatterX.API.chartOption.legend.align.value.set("Desc");
Name Type Required Description
value String O 값의 정렬 방법을 나타내는 문자열
  • None
  • Desc
  • Asc
2-6-3-2. Chart Option > Legend > Change
차트 범례에 대한 색상을 설정 할 수 있다.
ScatterX.API.chartOption.legend.change.get();
ScatterX.API.chartOption.legend.change.set([
   {name: "B6", color: "255,0,0"} 
]);
Name Type Required Description
value Object O 범례의 색상을 설정
2-6-4. Chart Option > Panel
차트 패널에 대한 색상 및 여백을 설정 할 수 있다.
  • Border
  • Background
  • Margin
2-6-4-1. Chart Option > Panel > Border
차트 패널의 테두리에 대한 설정을 할 수 있다.
  • Visible
  • Color
2-6-4-1-1. Chart Option > Panel > Border > Visible
ScatterX.API.chartOption.panel.border.visible.get();
ScatterX.API.chartOption.panel.border.visible.set(true);
Name Type Required Description
value Boolean O 패널 테두리 표시 여부를 나타내는 값
2-6-4-1-2. Chart Option > Panel > Border > Color
ScatterX.API.chartOption.panel.border.color.get();
ScatterX.API.chartOption.panel.border.color.set("255,0,0");
Name Type Required Description
value String O 테두리 색상을 나타내는 문자열 (RGB값)
2-6-4-2. Chart Option > Panel > Background
차트 패널의 바탕색을 설정할 수 있다.

2-6-4-2-1. Chart Option > Panel > Background > Gradient
ScatterX.API.chartOption.panel.background.gradient.get();
ScatterX.API.chartOption.panel.background.gradient.set(true);
Name Type Required Description
value Boolean O 바탕색에 그라데이션을 적용할지 여부를 나타내는 값
2-6-4-2-2. Chart Option > Panel > Background > Color
ScatterX.API.chartOption.panel.background.color.get();
ScatterX.API.chartOption.panel.background.color.set("128,128,128");
Name Type Required Description
value String O 바탕색을 나타내는 문자열 (RGB값)
2-6-4-3. Chart Option > Panel > Margin
패널의 여백을 설정할 수 있다.
  • Top
  • Right
  • Bottom
  • Left
ScatterX.API.chartOption.panel.margin.top.get();
ScatterX.API.chartOption.panel.margin.top.set(5);
Name Type Required Description
value Number O 상단 여백 나타내는 숫자
ScatterX.API.chartOption.panel.margin.right.get();
ScatterX.API.chartOption.panel.margin.right.set(5);
Name Type Required Description
value Number O 우측 여백 나타내는 숫자
ScatterX.API.chartOption.panel.margin.bottom.get();
ScatterX.API.chartOption.panel.margin.bottom.set(5);
Name Type Required Description
value Number O 하단 여백을 나타내는 숫자
ScatterX.API.chartOption.panel.margin.left.get();
ScatterX.API.chartOption.panel.margin.left.set(5);
Name Type Required Description
value Number O 좌측 여백을 나타내는 숫자
2-6-5. Chart Option > Palette
차트에서 사용하는 색상을 설정할 수 있다.
  • Default Color
  • Color List
  • Gradation
2-6-5-1. Chart Option > Palette > Default Color
ScatterX.API.chartOption.palette.defaultColor.get();
ScatterX.API.chartOption.palette.defaultColor.set("65,105,225");
Name Type Required Description
value String O 기본 색상을 나타내는 문자열 (RGB값)
2-6-5-2. Chart Option > Palette > Color List
ScatterX.API.chartOption.palette.colorList.get();
ScatterX.API.chartOption.palette.colorList.set([
   "65,105,225",
   "112,110,188",
   "160,116,152",
   "207,121,116",
   "255,127,80"
]);
Name Type Required Description
value Array O 차트에서 사용하는 팔레트 색상을 나타내는 문자 배열
2-6-5-3. Chart Option > Palette > Gradation
팔레트 색상을 그라데이션이 적용된 색상으로 사용할 수 있다.
  • Enable
  • Start
  • Middle
  • End
  • Grade Count
  • Reverse
2-6-5-3-1. Chart Option > Palette > Gradation > Enable
ScatterX.API.chartOption.palette.gradation.enable.get();
ScatterX.API.chartOption.palette.gradation.enable.set(true);
Name Type Required Description
value Boolean O 팔레트 색상을 그라데이션으로 사용할지 여부를 나타내는 값
2-6-5-3-2. Chart Option > Palette > Gradation > Start
ScatterX.API.chartOption.palette.gradation.start.color.get();
ScatterX.API.chartOption.palette.gradation.start.color.set("255,0,0");
Name Type Required Description
value String O 그라데이션 처음 색상을 나타내는 문자열 (RGB값)
2-6-5-3-3. Chart Option > Palette > Gradation > Middle
ScatterX.API.chartOption.palette.gradation.middle.enable.get();
ScatterX.API.chartOption.palette.gradation.middle.enable.set(true);
Name Type Required Description
value Boolean O 그라데이션 색상에 중간 색상을 사용할지 여부를 나타내는 값
ScatterX.API.chartOption.palette.gradation.middle.color.get();
ScatterX.API.chartOption.palette.gradation.middle.color.set("0,255,0");
Name Type Required Description
value String O 그라데이션 중간 색상을 나타내는 문자열 (RGB값)
2-6-5-3-4. Chart Option > Palette > Gradation > End
ScatterX.API.chartOption.palette.gradation.end.color.get();
ScatterX.API.chartOption.palette.gradation.end.color.set("0,0,255");
Name Type Required Description
value String O 그라데이션 마지막 색상을 나타내는 문자열 (RGB값)
2-6-5-3-5. Chart Option > Palette > Gradation > Grade Count
ScatterX.API.chartOption.palette.gradation.gradeCount.get();
ScatterX.API.chartOption.palette.gradation.gradeCount.set(10);
Name Type Required Description
value Number O 그라데이션 단계를 나타내는 숫자
2-6-5-3-6. Chart Option > Palette > Gradation > Reverse
ScatterX.API.chartOption.palette.gradation.reverse.get();
ScatterX.API.chartOption.palette.gradation.reverse.set(true);
Name Type Required Description
value Boolean O 그라데이션 색상 순서를 역순으로 사용할지 여부를 나타내는 값
2-6-6. Chart Option > Shape
분산 차트에서 사용하는 포인트의 모양을 설정할 수 있다.
  • Default Shape
  • Point Style
  • Shape Style
  • Transparency
  • Gradient
  • Border Width
2-6-6-1. Chart Option > Shape > Default Shape
차트에서 사용하는 포인트의 기본 모양을 설정할 수 있다.
// Default Shape
ScatterX.API.chartOption.shape.defaultShape.get();
// Default Shape 2
ScatterX.API.chartOption.shape.defaultShape2.get();
// Default Shape
ScatterX.API.chartOption.shape.defaultShape.set("Circle");
// Default Shape 2
ScatterX.API.chartOption.shape.defaultShape2.set("LeftTriangle");
Name Type Required Description
value String O 포인트의 기본 모양을 나타내는 문자열
  • Circle
  • Rectangle
  • Triangle
  • DownTriangle
  • LeftTriangle
  • RightTriangle
  • Diamond
  • Cross
  • Hexagon
  • Star
2-6-6-2. Chart Option > Shape > Point Style
포인트 스타일을 설정할 수 있다.
(*Scatter, Line 차트)
ScatterX.API.chartOption.shape.pointStyle.get();
ScatterX.API.chartOption.shape.pointStyle.set("Border");
Name Type Required Description
value String O 포인트 스타일을 나타내는 문자열
  • Both
  • Border
  • Brush
2-6-6-3. Chart Option > Shape > Shape Style
모양 스타일을 설정할 수 있다.
ScatterX.API.chartOption.shape.shapeStyle.get();
ScatterX.API.chartOption.shape.shapeStyle.set("Border");
Name Type Required Description
value String O 모양 스타일을 나타내는 문자열
  • Both
  • Border
  • Brush
2-6-6-4. Chart Option > Shape > Transparency
포인트/모양의 투명도를 설정할 수 있다.
ScatterX.API.chartOption.shape.transparency.get();
ScatterX.API.chartOption.shape.transparency.set(50);
Name Type Required Description
value Number O 포인트/모양의 투명도를 나타내는 숫자
2-6-6-5. Chart Option > Shape > Gradient
포인트/모양의 그라데이션을 설정할 수 있다.
ScatterX.API.chartOption.shape.gradient.enable.get();
ScatterX.API.chartOption.shape.gradient.enable.set(true);
Name Type Required Description
value Boolean O 포인트/모양의 그라데이션 여부를 나타내는 값
2-6-6-6. Chart Option > Shape > Border Width
포인트/모양의 선 너비를 설정할 수 있다.
ScatterX.API.chartOption.shape.border.width.get();
ScatterX.API.chartOption.shape.border.width.set(1);
Name Type Required Description
value Number O 포인트/모양의 선 너비를 나타내는 값
2-6-7. Chart Option > Size
차트에서 사용하는 크기에 관한 설정을 할 수 있다.
  • Point
  • Font
  • Line
2-6-7-1. Chart Option > Size > Point
  • Auto
  • Auto Size
  • Fixed Size
  • Size By
2-6-7-1-1. Chart Option > Size > Point > Auto
ScatterX.API.chartOption.size.point.auto.get();
ScatterX.API.chartOption.size.point.auto.set(true);
Name Type Required Description
value Boolean O 포인트 사이즈를 자동으로 사용할지 여부를 나타내는 값
2-6-7-1-2. Chart Option > Size > Point > Auto Size
ScatterX.API.chartOption.size.point.autoSize.get();
ScatterX.API.chartOption.size.point.autoSize.set(true);
Name Type Required Description
value Number O 자동으로 사이즈를 설정할 때 포인트 비율을 나타내는 숫자
2-6-7-1-3. Chart Option > Size > Point > Fixed Size
ScatterX.API.chartOption.size.point.fixedSize.get();
ScatterX.API.chartOption.size.point.fixedSize.set(15);
Name Type Required Description
value Number O 고정 사이즈로 사용할 때 포인트 크기를 나타내는 숫자
2-6-7-1-4. Chart Option > Size > Point > Size By
  • Min
  • Max
2-6-7-1-4-1. Chart Option > Size > Point > Size By > Min
ScatterX.API.chartOption.size.point.sizeBy.min.get();
ScatterX.API.chartOption.size.point.sizeBy.min.set(12);
Name Type Required Description
value Number O Size By 설정을 하였을 때 포인트 크기의 최소값을 나타내는 숫자
2-6-7-1-4-2. Chart Option > Size > Point > Size By > Max
ScatterX.API.chartOption.size.point.sizeBy.max.get();
ScatterX.API.chartOption.size.point.sizeBy.max.set(15);
Name Type Required Description
value String O Size By 설정을 하였을 때 포인트 크기의 최대값을 나타내는 숫자
2-6-7-2. Chart Option > Size > Font
글꼴 크기에 대한 설정을 할 수 있다.
  • Auto
  • Min
  • Max
  • Label Max Size
  • Size Step Count
  • Resolution
2-6-7-2-1. Chart Option > Size > Font > Auto
ScatterX.API.chartOption.size.font.auto.get();
ScatterX.API.chartOption.size.font.auto.set(true);
Name Type Required Description
value Boolean O 글꼴 크기를 자동으로 사용할지 여부를 나타내는 값
2-6-7-2-2. Chart Option > Size > Font > Min
ScatterX.API.chartOption.size.font.min.get();
ScatterX.API.chartOption.size.font.min.set(12);
Name Type Required Description
value Number O 글꼴 크기의 최소 크기를 나타내는 숫자
2-6-7-2-3. Chart Option > Size > Font > Max
ScatterX.API.chartOption.size.font.max.get();
ScatterX.API.chartOption.size.font.max.set(15);
Name Type Required Description
value Number O 글꼴 크기의 최대 크기를 나타내는 숫자
2-6-7-2-4. Chart Option > Size > Font > Label Max Size
ScatterX.API.chartOption.size.font.labelMaxSize.get();
ScatterX.API.chartOption.size.font.labelMaxSize.set(17);
Name Type Required Description
value Number O 축 라벨 글꼴 크기의 최대 크기를 나타내는 숫자
2-6-7-2-5. Chart Option > Size > Font > Size Step Count
ScatterX.API.chartOption.size.font.sizeStepCount.get();
ScatterX.API.chartOption.size.font.sizeStepCount.set(10);
Name Type Required Description
value Number O 크기 단계를 나타내는 숫자
2-6-7-2-6. Chart Option > Size > Font > Resolution
글꼴 크기를 자동으로 설정할 때 기준이 되는 해상도를 설정할 수 있다.
  • Width
  • Height
2-6-7-2-6-1. Chart Option > Size > Font > Resolution > Width
ScatterX.API.chartOption.size.font.resolution.width.get();
ScatterX.API.chartOption.size.font.resolution.width.set(1800);
Name Type Required Description
value Number O 해상도 너비를 나타내는 숫자
2-6-7-2-6-2. Chart Option > Size > Font > Resolution > Height
ScatterX.API.chartOption.size.font.resolution.height.get();
ScatterX.API.chartOption.size.font.resolution.height.set(720);
Name Type Required Description
value Number O 해상도 높이를 나타내는 숫자
2-6-7-3. Chart Option > Size > Line
차트에서 사용하는 선에 대한 설정을 할 수 있다.

2-6-7-3-1. Chart Option > Size > Line > Width
ScatterX.API.chartOption.size.line.width.get();
ScatterX.API.chartOption.size.line.width.set(3);
Name Type Required Description
value Number O 선 너비를 나타내는 숫자
2-6-8. Chart Option > Point Label
포인트 라벨에 대한 설정을 할 수 있다.
  • Layout
  • Text
  • Label Format
  • Line
  • Box
2-6-8-1. Chart Option > Point Label > Layout
포인트 라벨의 레이아웃에 대한 설정을 할 수 있다.
  • Visible
  • Angle
  • Horizontal
  • Vertical
2-6-8-1-1. Chart Option > Point Label > Layout > Visible
ScatterX.API.chartOption.pointLabel.layout.visible.get();
ScatterX.API.chartOption.pointLabel.layout.visible.set("Selected");
Name Type Required Description
value String O 포인트 라벨의 표시 유형을 나타내는 문자열
  • None
  • All
  • SelectedPoints
  • FocusPoints
  • MinMax
2-6-8-1-1-1. Chart Option > Point Label > Layout > Visible > Min/Max > Miny
ScatterX.API.chartOption.pointLabel.layout.visible.minMax.miny.get();
ScatterX.API.chartOption.pointLabel.layout.visible.minMax.miny.set(true);
Name Type Required Description
value Boolean O 포인트 라벨의 표시 유형중 최대값/최소값으로 설정시 Miny의 여부를 나타내는 값
2-6-8-1-1-2. Chart Option > Point Label > Layout > Visible > Min/Max > Maxy
ScatterX.API.chartOption.pointLabel.layout.visible.minMax.maxy.get();
ScatterX.API.chartOption.pointLabel.layout.visible.minMax.maxy.set(true);
Name Type Required Description
value Boolean O 포인트 라벨의 표시 유형중 최대값/최소값으로 설정시 Maxy의 여부를 나타내는 값
2-6-8-1-1-3. Chart Option > Point Label > Layout > Visible > Min/Max > Minx
ScatterX.API.chartOption.pointLabel.layout.visible.minMax.minx.get();
ScatterX.API.chartOption.pointLabel.layout.visible.minMax.minx.set(false);
Name Type Required Description
value Boolean O 포인트 라벨의 표시 유형중 최대값/최소값으로 설정시 Minx의 여부를 나타내는 값
2-6-8-1-1-4. Chart Option > Point Label > Layout > Visible > Min/Max > Maxx
ScatterX.API.chartOption.pointLabel.layout.visible.minMax.maxx.get();
ScatterX.API.chartOption.pointLabel.layout.visible.minMax.maxx.set(false);
Name Type Required Description
value Boolean O 포인트 라벨의 표시 유형중 최대값/최소값으로 설정시 Maxx의 여부를 나타내는 값
2-6-8-1-2. Chart Option > Point Label > Layout > Angle
ScatterX.API.chartOption.pointLabel.layout.angle.get();
ScatterX.API.chartOption.pointLabel.layout.angle.set(45);
Name Type Required Description
value Number O 각도를 나타내는 숫자
2-6-8-1-3. Chart Option > Point Label > Layout > Horizontal
ScatterX.API.chartOption.pointLabel.layout.horizontal.get();
ScatterX.API.chartOption.pointLabel.layout.horizontal.set("Center");
Name Type Required Description
value String O 포인트 라벨의 수평 정렬을 나타내는 문자열
  • Left
  • Center
  • Right
2-6-8-1-4. Chart Option > Point Label > Layout > Vertical
ScatterX.API.chartOption.pointLabel.layout.vertical.get();
ScatterX.API.chartOption.pointLabel.layout.vertical.set("Center");
Name Type Required Description
value String O 포인트 라벨의 수직 정렬을 나타내는 문자열
  • Top
  • Center
  • Bottom
2-6-8-2. Chart Option > Point Label > Text
포인트 라벨의 글자에 대한 설정을 할 수 있다.

2-6-8-2-1. Chart Option > Point Label > Text > Font
ScatterX.API.chartOption.pointLabel.text.font.name.get();
ScatterX.API.chartOption.pointLabel.text.font.name.set("Arial");
Name Type Required Description
value String O 글꼴 이름을 나타내는 문자열
ScatterX.API.chartOption.pointLabel.text.font.style.get();
ScatterX.API.chartOption.pointLabel.text.font.style.set("bold");
Name Type Required Description
value String O 글꼴 스타일을 나타내는 문자열
  • Regular
  • Bold
  • Italic
  • BoldItalic
ScatterX.API.chartOption.pointLabel.text.font.size.get();
ScatterX.API.chartOption.pointLabel.text.font.size.set(15);
Name Type Required Description
value Number O 글꼴 크기를 나타내는 숫자
ScatterX.API.chartOption.pointLabel.text.font.color.get();
ScatterX.API.chartOption.pointLabel.text.font.color.set("255,0,0");
Name Type Required Description
value String O 글꼴 색상을 나타내는 문자열 (RGB값)
2-6-8-3. Chart Option > Point Label > Label Format
포인트 라벨 형식에 대한 설정을 할 수 있다.
  • Value
  • Format
  • Prefix
  • Suffix
  • Decimal Places
2-6-8-3-1. Chart Option > Point Label > Label Format > Value
ScatterX.API.chartOption.pointLabel.labelFormat.value.get();
ScatterX.API.chartOption.pointLabel.labelFormat.value.set("YValue");
Name Type Required Description
value String O 라벨 값을 나타내는 문자열
  • Series
  • XValue
  • YValue
2-6-8-3-2. Chart Option > Point Label > Label Format > Format
ScatterX.API.chartOption.pointLabel.labelFormat.format.get();
ScatterX.API.chartOption.pointLabel.labelFormat.format.set("#,##0");
Name Type Required Description
value String O 라벨 형식을 나타내는 문자열
2-6-8-3-3. Chart Option > Point Label > Label Format > Prefix
ScatterX.API.chartOption.pointLabel.labelFormat.prefix.get();
ScatterX.API.chartOption.pointLabel.labelFormat.prefix.set("prefix");
Name Type Required Description
value String O 라벨 접두사를 나타내는 문자열
2-6-8-3-4. Chart Option > Point Label > Label Format > Suffix
ScatterX.API.chartOption.pointLabel.labelFormat.suffix.get();
ScatterX.API.chartOption.pointLabel.labelFormat.suffix.set("suffix");
Name Type Required Description
value String O 라벨 접미사를 나타내는 문자열
2-6-8-3-5. Chart Option > Point Label > Label Format > Decimal Places
ScatterX.API.chartOption.pointLabel.labelFormat.decimalPlaces.get();
ScatterX.API.chartOption.pointLabel.labelFormat.decimalPlaces.set(2);
Name Type Required Description
value String O 소수점 자릿수를 나타내는 숫자
2-6-8-4. Chart Option > Point Label > Line
포인트 라벨 선에 대한 설정을 할 수 있다.
  • Style
  • Width
  • Color
  • Length
2-6-8-4-1. Chart Option > Point Label > Line > Style
ScatterX.API.chartOption.pointLabel.line.linestyle.get();
ScatterX.API.chartOption.pointLabel.line.linestyle.set("Solid");
Name Type Required Description
value String O 선 종류를 나타내는 문자열
2-6-8-4-2. Chart Option > Point Label > Line > Width
ScatterX.API.chartOption.pointLabel.line.width.get();
ScatterX.API.chartOption.pointLabel.line.width.set(2);
Name Type Required Description
value Number O 선 너비를 나타내는 숫자
2-6-8-4-3. Chart Option > Point Label > Line > Color
ScatterX.API.chartOption.pointLabel.line.color.get();
ScatterX.API.chartOption.pointLabel.line.color.set("255,0,0");
Name Type Required Description
value Color O 선 색상을 나타내는 문자열 (RGB값)
2-6-8-4-4. Chart Option > Point Label > Line > Length
ScatterX.API.chartOption.pointLabel.line.length.get();
ScatterX.API.chartOption.pointLabel.line.length.set(7);
Name Type Required Description
value Number O 선 길이를 나타내는 숫자
2-6-8-5. Chart Option > Point Label > Box
포인트 라벨 박스를 설정할 수 있다.
  • Visible
  • Background
  • Border
  • Width
2-6-8-5-1. Chart Option > Point Label > Box > Visible
ScatterX.API.chartOption.pointLabel.box.visible.get();
ScatterX.API.chartOption.pointLabel.box.visible.set(true);
Name Type Required Description
value Boolean O 테두리 표시 여부를 나타내는 값
2-6-8-5-2. Chart Option > Point Label > Box > Background > Color
ScatterX.API.chartOption.pointLabel.box.background.color.get();
ScatterX.API.chartOption.pointLabel.box.background.color.set("128,128,128");
Name Type Required Description
value String O 바탕색을 나타내는 문자열 (RGB값)
2-6-8-5-3. Chart Option > Point Label > Box > Border > Color
ScatterX.API.chartOption.pointLabel.box.border.color.get();
ScatterX.API.chartOption.pointLabel.box.border.color.set("128,128,128");
Name Type Required Description
value String O 테두리 색상을 나타내는 문자열 (RGB값)
2-6-8-5-4. Chart Option > Point Label > Box > Width
ScatterX.API.chartOption.pointLabel.box.width.get();
ScatterX.API.chartOption.pointLabel.box.width.set(2);
Name Type Required Description
value Number O 테두리 두께를 나타내는 숫자
2-6-9. Chart Option > Wafer
웨이퍼 패턴분석에 대한 설정을 할 수 있다.
  • Visible Text
  • Pattern Type
  • Clustering
2-6-9-1. Chart Option > Wafer > Visible Text
ScatterX.API.chartOption.wafer.visibleText.get();
ScatterX.API.chartOption.wafer.visibleText.set(true);
Name Type Required Description
value Boolean O 분석 내용의 표시 여부를 나타내는 값
2-6-9-2. Chart Option > Wafer > Pattern Type
웨이퍼 패턴분석의 유형을 설정할 수 있다.
ScatterX.API.chartOption.wafer.patternType.get();
ScatterX.API.chartOption.wafer.patternType.set("Clustering");
Name Type Required Description
value String O 패턴 유형을 나타내는 문자열
  • None
  • Classification
  • Clustering
  • Zone
2-6-9-3. Chart Option > Wafer > Clustering
클러스터링 유형에 대한 세부 설정을 할 수 있다.
  • Auto
  • Max
  • K-value
  • Seed
2-6-9-3-1. Chart Option > Wafer > Clustering > Auto
ScatterX.API.chartOption.wafer.clustering.auto.get();
ScatterX.API.chartOption.wafer.clustering.auto.set(true);
Name Type Required Description
value Boolean O 군집수를 자동으로 설정할지 여부를 나타내는 값
2-6-9-3-2. Chart Option > Wafer > Clustering > K-value
ScatterX.API.chartOption.wafer.clustering.kvalue.get();
ScatterX.API.chartOption.wafer.clustering.kvalue.set(20);
Name Type Required Description
value Number O 군집수를 나타내는 숫자
2-6-9-3-3. Chart Option > Wafer > Clustering > Max
ScatterX.API.chartOption.wafer.clustering.max.get();
ScatterX.API.chartOption.wafer.clustering.max.set(30);
Name Type Required Description
value Number O 최대군집수를 나타내는 숫자
2-6-9-3-4. Chart Option > Wafer > Clustering > Seed
ScatterX.API.chartOption.wafer.clustering.seed.get();
ScatterX.API.chartOption.wafer.clustering.seed.set(0);
Name Type Required Description
value Number O 시드 값을 나타내는 숫자
2-6-10. Chart Option > Value
차트에서 사용하는 값에 대한 설정을 할 수 있다.
  • Null Value
2-6-10-1. Chart Option > Value > Null Value
차트에서 사용하는 Null에 대한 설정을 할 수 있다.
  • Null to Numeric Axis
  • Null to Timestamp Axis
  • Null to String
  • Null to Last
2-6-10-1-1. Chart Option > Value > Null Value > Null to Numeric Axis
숫자 축에서 Null을 대체할 값을 설정할 수 있다.
ScatterX.API.chartOption.value.nullValue.toNumericAxis.get();
ScatterX.API.chartOption.value.nullValue.toNumericAxis.set(0);
Name Type Required Description
value Number O Null을 대체할 숫자
2-6-10-1-2. Chart Option > Value > Null Value > Null to Timestamp Axis
날짜 축에서 Null을 대체할 값을 설정할 수 있다.
ScatterX.API.chartOption.value.nullValue.toTimestampAxis.get();
ScatterX.API.chartOption.value.nullValue.toTimestampAxis.set(1577836800000);
Name Type Required Description
value Number O (*단위 : 밀리초)
Null을 대체할 날짜
2-6-10-1-3. Chart Option > Value > Null Value > Null to String
문자열에서 Null을 대체할 값을 설정할 수 있다.
ScatterX.API.chartOption.value.nullValue.toString.get();
ScatterX.API.chartOption.value.nullValue.toString.set("[Null]");
Name Type Required Description
value String O Null을 대체할 문자열
2-6-10-1-4. Chart Option > Value > Null Value > Null to Last
Null을 마지막으로 정렬할지 여부를 설정할 수 있다.
ScatterX.API.chartOption.value.nullValue.toLast.get();
ScatterX.API.chartOption.value.nullValue.toLast.set(false);
Name Type Required Description
value Boolean O Null을 마지막으로 정렬할지 여부를 나타내는 값
2-6-11. Chart Option > Score
차트 스코어를 설정할 수 있다.
  • Type
  • Functions
  • UCL
  • LCL
  • Visible
  • Font
  • Backbround
  • Border
2-6-11-1. Chart Option > Score > Type
스코어 유형을 설정할 수 있다.
ScatterX.API.chartOption.score.type.get();
ScatterX.API.chartOption.score.type.set("Priority");
Name Type Required Description
value String O 스코어 유형을 나타내는 문자열
  • Priority
  • Average
2-6-11-2. Chart Option > Score > Functions
스코어에 적용할 함수를 설정할 수 있다.
ScatterX.API.chartOption.score.functions.get();
ScatterX.API.chartOption.score.functions.set(value[, columnObject]);
// Example
ScatterX.API.chartOption.score.functions.set([
   "fscore",
   "rscore",
   "zscore",
   "cpcpk"
], {
   ucl: "vib",
   lcl: "vib"
});
Name Type Required Description
value Array O 스코어에 적용할 함수를 설정하는 배열
  • fscore
  • rscore
  • zscore
  • cpcpk
columnObject Object △ (*value에 zscore나 cpcpk가 있을 때)
스코어에 적용할 UCL/LCL을 설정
  • ucl
  • lcl
2-6-11-3. Chart Option > Score > UCL
스코어 UCL을 설정할 수 있다.
ScatterX.API.chartOption.score.ucl.get();
ScatterX.API.chartOption.score.ucl.set("vib");
Name Type Required Description
value String O 스코어 UCL을 설정하는 문자열
2-6-11-4. Chart Option > Score > LCL
스코어 LCL을 설정할 수 있다.
ScatterX.API.chartOption.score.lcl.get();
ScatterX.API.chartOption.score.lcl.set("vib");
Name Type Required Description
value String O 스코어 LCL을 설정하는 문자열
2-6-11-5. Chart Option > Score > Visible
ScatterX.API.chartOption.score.visible.get();
ScatterX.API.chartOption.score.visible.set(true);
Name Type Required Description
value Boolean O 스코어 표시 여부를 나타내는 값
2-6-11-6. Chart Option > Score > Font
ScatterX.API.chartOption.score.font.name.get();
ScatterX.API.chartOption.score.font.name.set("Arial");
Name Type Required Description
value String O 글꼴 이름을 나타내는 문자열
ScatterX.API.chartOption.score.font.style.get();
ScatterX.API.chartOption.score.font.style.set("bold");
Name Type Required Description
value String O 글꼴 스타일을 나타내는 문자열
  • Regular
  • Bold
  • Italic
  • BoldItalic
ScatterX.API.chartOption.score.font.size.get();
ScatterX.API.chartOption.score.font.size.set(12);
Name Type Required Description
value Number O 글꼴 크기를 나타내는 숫자
ScatterX.API.chartOption.score.font.color.get();
ScatterX.API.chartOption.score.font.color.set("255,0,0");
Name Type Required Description
value String O 글꼴 색상을 나타내는 문자열 (RGB값)
2-6-11-7. Chart Option > Score > Background
차트 스코어의 바탕색을 설정할 수 있다.
ScatterX.API.chartOption.score.backbround.color.get();
ScatterX.API.chartOption.score.backbround.color.set("255,0,0");
Name Type Required Description
value String O 바탕색을 나타내는 문자열 (RGB값)
2-6-11-8. Chart Option > Score > Border
차트 스코어의 테두리를 설정할 수 있다.
  • Color
  • Width
2-6-11-8-1. Chart Option > Score > Border > Color
ScatterX.API.chartOption.score.border.color.get();
ScatterX.API.chartOption.score.border.color.set("255,0,0");
Name Type Required Description
value String O 테두리 색상을 나타내는 문자열 (RGB값)
2-6-11-8-2. Chart Option > Score > Border > Width
ScatterX.API.chartOption.score.border.width.get();
ScatterX.API.chartOption.score.border.width.set(2);
Name Type Required Description
value Number O 테두리 두께를 나타내는 숫자
2-6-12. Chart Option > Prediction
차트 예측을 설정할 수 있다.
  • Predict
  • Description
  • Data Aggregation
  • Average Size
  • Predict Period
  • Center Average
  • Automatic
  • Error Type
  • Trend Type
  • Seasonal Type
  • Frequency
  • Damped
  • Show Interval
2-6-12-1. Chart Option > Prediction > Predict
차트 예측 여부를 설정할 수 있다.
ScatterX.API.chartOption.prediction.predict.get();
ScatterX.API.chartOption.prediction.predict.set(true);
Name Type Required Description
value Boolean O 차트 예측 여부를 나타내는 값
2-6-12-1-1. Chart Option > Prediction > Predict > Type
차트 예측 유형을 설정할 수 있다.
ScatterX.API.chartOption.prediction.predict.type.get();
ScatterX.API.chartOption.prediction.predict.type.set(2);
Name Type Required Description
value Number O 차트 예측 유형을 나타내는 값
  • 1 : Simple Moving Average(단순이동평균선)
  • 2 : Simple Exponential Smoothing(단순 지수 평활법)
  • 3 : Double Exponential Smoothing(이중 지수 평활법)
  • 4 : Holt-Winters Exponential Smoothing(삼중 지수 평활법)
2-6-12-2. Chart Option > Prediction > Description
차트 예측 설명 여부를 설정할 수 있다.
ScatterX.API.chartOption.prediction.description.get();
ScatterX.API.chartOption.prediction.description.set(true);
Name Type Required Description
value Boolean O 차트 예측 설명 여부를 나타내는 값
2-6-12-3. Chart Option > Prediction > Data Aggregation
차트 예측 데이터 집계를 설정할 수 있다.
ScatterX.API.chartOption.prediction.dataAggregation.get();
ScatterX.API.chartOption.prediction.dataAggregation.set("Avg");
Name Type Required Description
value String O 차트 예측 데이터 집계를 나타내는 값
  • Avg
  • Sum
  • Min
  • Max
2-6-12-4. Chart Option > Prediction > Average Size
차트 예측 이동 평균 길이를 설정할 수 있다.
ScatterX.API.chartOption.prediction.averageSize.get();
ScatterX.API.chartOption.prediction.averageSize.set(2);
Name Type Required Description
value Number O 차트 예측 이동 평균 길이를 나타내는 값
2-6-12-5. Chart Option > Prediction > Predict Period
차트 예측수를 설정할 수 있다.
ScatterX.API.chartOption.prediction.predictPeriod.get();
ScatterX.API.chartOption.prediction.predictPeriod.set(2);
Name Type Required Description
value Number O 차트 예측수를 나타내는 값
2-6-12-6. Chart Option > Prediction > Center Average
차트 예측 중앙평균을 설정할 수 있다.
ScatterX.API.chartOption.prediction.centerAverage.get();
ScatterX.API.chartOption.prediction.centerAverage.set(true);
Name Type Required Description
value Boolean O 차트 예측 중앙평균 여부를 나타내는 값
2-6-12-7. Chart Option > Prediction > Automatic
차트 예측 자동 여부를 설정할 수 있다.
ScatterX.API.chartOption.prediction.automatic.get();
ScatterX.API.chartOption.prediction.automatic.set(true);
Name Type Required Description
value Boolean O 차트 예측 자동 여부를 나타내는 값
2-6-12-7-1. Chart Option > Prediction > Automatic > Alpha
차트 예측 자동 수준을 설정할 수 있다.
(*Predict Type2, Type3에서 Automatic False일 때 지원)
ScatterX.API.chartOption.prediction.automatic.alpha.get();
ScatterX.API.chartOption.prediction.automatic.alpha.set(0.45);
Name Type Required Description
value Number O 차트 예측 자동 수준를 나타내는 값
(*0.1 ~ 0.99)
2-6-12-7-2. Chart Option > Prediction > Automatic > Beta
차트 예측 자동 추세를 설정할 수 있다.
(*Predict Type3에서 Automatic False일 때 지원)
ScatterX.API.chartOption.prediction.automatic.beta.get();
ScatterX.API.chartOption.prediction.automatic.beta.set(0.45);
Name Type Required Description
value Number O 차트 예측 자동 추세를 나타내는 값
(*0.1 ~ 0.99)
2-6-12-8. Chart Option > Prediction > Damped
차트 예측 감쇠를 설정할 수 있다.
ScatterX.API.chartOption.prediction.damped.get();
ScatterX.API.chartOption.prediction.damped.set(true);
Name Type Required Description
value Boolean O 차트 예측 감쇠 여부를 나타내는 값
2-6-12-9. Chart Option > Prediction > Error Type
차트 예측 수준 유형을 설정할 수 있다.
ScatterX.API.chartOption.prediction.errorType.get();
ScatterX.API.chartOption.prediction.errorType.set("additive");
Name Type Required Description
value String O 차트 예측 수준 유형을 나타내는 값
  • additive
  • multiplicative
2-6-12-10. Chart Option > Prediction > Trend Type
차트 예측 추세 유형을 설정할 수 있다.
ScatterX.API.chartOption.prediction.trendType.get();
ScatterX.API.chartOption.prediction.trendType.set("additive");
Name Type Required Description
value String O 차트 예측 추세 유형을 나타내는 값
  • additive
  • multiplicative
2-6-12-11. Chart Option > Prediction > Seasonal Type
차트 예측 계절 유형을 설정할 수 있다.
ScatterX.API.chartOption.prediction.seasonalType.get();
ScatterX.API.chartOption.prediction.seasonalType.set("additive");
Name Type Required Description
value String O 차트 예측 계절 유형을 나타내는 값
  • additive
  • multiplicative
2-6-12-12. Chart Option > Prediction > Frequency
차트 예측 계절길이를 설정할 수 있다.
ScatterX.API.chartOption.prediction.frequency.get();
ScatterX.API.chartOption.prediction.frequency.set(12);
Name Type Required Description
value Number O 차트 예측 계절길이를 나타내는 값
2-6-12-13. Chart Option > Prediction > Show Interval
차트 예측 신뢰구간을 설정할 수 있다.
ScatterX.API.chartOption.prediction.showInterval.get();
ScatterX.API.chartOption.prediction.showInterval.set(0.45);
Name Type Required Description
value Number O 차트 예측 신뢰구간을 나타내는 값
(*0.1 ~ 0.99)
2-6-13. Chart Option > Selection
차트 선택영역 항목을 설정할 수 있다.
  • Default Fields
  • Fields
  • Concat String
2-6-13-1. Chart Option > Selection > Default Fields
차트 선택영역 항목의 기본설정 여부를 선택할 수 있도록 제공한다.
ScatterX.API.chartOption.selection.defaultFields.get();
ScatterX.API.chartOption.selection.defaultFields.set(true);
Name Type Required Description
value Boolean O 차트 선택영역 항목의 기본설정 여부를 나타내는 값
2-6-13-2. Chart Option > Selection > Fields
차트 선택영역 항목의 필드 값을 설정할 수 있도록 제공한다.
ScatterX.API.chartOption.selection.fields.get();
ScatterX.API.chartOption.selection.fields.set("Color,X");
Name Type Required Description
value String O 차트 선택영역 항목의 필드 값
(*Timestamp 컬럼 타입 지원 X)
  • None(*Default)
  • Marker
  • Color
  • Shape
  • Group
  • X
  • Y1
2-6-13-3. Chart Option > Selection > Concat String
차트 선택영역 항목간 연결문자를 설정할 수 있도록 제공한다.
ScatterX.API.chartOption.selection.concatString.get();
ScatterX.API.chartOption.selection.concatString.set("_");
Name Type Required Description
value String O 차트 선택영역 항목간 연결문자를 나타내는 문자열
2-7. Tooltip
툴팁을 설정할 수 있다.
  • Clicking
2-7-1. Tooltip > Clicking
툴팁 클릭 이벤트에 대한 설정을 할 수 있으며 아래의 항목들을 설정할 수 있도록 제공한다.
  • Gallery
  • Analytics
  • Real Time
  • Dashboard
  • Real Time Dashboard
  • Share
  • Batch
  • Template
  • Unit
2-7-1-1. Tooltip > Clicking > Gallery
Gallery에서 툴팁 클릭 이벤트를 설정할 수 있다.
ScatterX.API.tooltip.clicking.gallery.get();
ScatterX.API.tooltip.clicking.gallery.set(true);
Name Type Required Description
value Boolean O Gallery에서 툴팁 클릭 이벤트 여부를 나타내는 값
2-7-1-2. Tooltip > Clicking > Analytics
Analytics에서 툴팁 클릭 이벤트를 설정할 수 있다.
ScatterX.API.tooltip.clicking.analytics.get();
ScatterX.API.tooltip.clicking.analytics.set(true);
Name Type Required Description
value Boolean O Analytics에서 툴팁 클릭 이벤트 여부를 나타내는 값
2-7-1-3. Tooltip > Clicking > Real Time
Real Time에서 툴팁 클릭 이벤트를 설정할 수 있다.
ScatterX.API.tooltip.clicking.realTime.get();
ScatterX.API.tooltip.clicking.realTime.set(true);
Name Type Required Description
value Boolean O Real Time에서 툴팁 클릭 이벤트 여부를 나타내는 값
2-7-1-4. Tooltip > Clicking > Dashboard
Dashboard에서 툴팁 클릭 이벤트를 설정할 수 있다.
ScatterX.API.tooltip.clicking.dashboard.get();
ScatterX.API.tooltip.clicking.dashboard.set(true);
Name Type Required Description
value Boolean O Dashboard에서 툴팁 클릭 이벤트 여부를 나타내는 값
2-7-1-5. Tooltip > Clicking > Real Time Dashboard
Real Time Dashboard에서 툴팁 클릭 이벤트를 설정할 수 있다.
ScatterX.API.tooltip.clicking.realTimeDashboard.get();
ScatterX.API.tooltip.clicking.realTimeDashboard.set(true);
Name Type Required Description
value Boolean O Real Time Dashboard에서 툴팁 클릭 이벤트 여부를 나타내는 값
2-7-1-6. Tooltip > Clicking > Share
Share에서 툴팁 클릭 이벤트를 설정할 수 있다.
ScatterX.API.tooltip.clicking.share.get();
ScatterX.API.tooltip.clicking.share.set(true);
Name Type Required Description
value Boolean O Share에서 툴팁 클릭 이벤트 여부를 나타내는 값
2-7-1-7. Tooltip > Clicking > Batch
Batch에서 툴팁 클릭 이벤트를 설정할 수 있다.
ScatterX.API.tooltip.clicking.batch.get();
ScatterX.API.tooltip.clicking.batch.set(true);
Name Type Required Description
value Boolean O Batch에서 툴팁 클릭 이벤트 여부를 나타내는 값
2-7-1-8. Tooltip > Clicking > Template
Template에서 툴팁 클릭 이벤트를 설정할 수 있다.
ScatterX.API.tooltip.clicking.template.get();
ScatterX.API.tooltip.clicking.template.set(true);
Name Type Required Description
value Boolean O Template에서 툴팁 클릭 이벤트 여부를 나타내는 값
2-7-1-9. Tooltip > Clicking > Unit
Unit에서 툴팁 클릭 이벤트를 설정할 수 있다.
ScatterX.API.tooltip.clicking.unit.get();
ScatterX.API.tooltip.clicking.unit.set(true);
Name Type Required Description
value Boolean O Unit에서 툴팁 클릭 이벤트 여부를 나타내는 값
2-8. Menu
메뉴에 대한 설정으로 메뉴 표시 설정(visible) 및 접히는 기능(collapse)을 제공한다.

2-8-1. Menu > Visible
메뉴 표시에 대한 설정으로 좌측에 생성되는 메뉴를 보이게 / 보이지 않게 설정할 수 있다.
ScatterX.API.menu.visible.get();
ScatterX.API.menu.visible.set(false);
Name Type Required Description
value Boolean O 메뉴 표시 여부를 나타내는 값
2-8-2. Menu > Collapse
접히는 메뉴 기능을 사용하는 설정으로 기본적으로 visible 속성이 true일 때만 사용할 수 있다.
ScatterX.API.menu.collapse.get();
ScatterX.API.menu.collapse.set(true);
Name Type Required Description
value Boolean O 접히는 메뉴 기능 사용 여부를 나타내는 값
2-8-3. Menu > Parameter
메뉴 파라미터에 대한 설정을 할 수 있으며 아래의 항목들을 설정 할 수 있도록 제공한다.
  • Disable
// key: 메뉴 파라미터 이름
// disable: 비활성화 여부
ScatterX.API.menu.parameter.set([
   {key: "x", disable: false} 
]);
Name Type Required Description
value Object O 차트 메뉴 파라미터의 설정을 나타내는 배열
현재 설정된 메뉴 파라미터를 적용할 수 있다.
ScatterX.API.menu.parameter.apply();
현재 설정된 메뉴 파라미터를 초기화할 수 있다.
ScatterX.API.menu.parameter.reset();
2-9. Tab
차트를 생성할 때 탭 기능을 사용할 수 있다.
ScatterX.API.tab.enable.get();
ScatterX.API.tab.enable.set(true);
Name Type Required Description
value Boolean O 탭 기능 사용 여부를 나타내는 값
2-10. Dropdown
드롭다운 기능을 설정할 수 있다.
  • Binding
2-10-1. Dropdown > Binding
드롭다운 바인딩에 대한 설정을 할 수 있다.
ScatterX.API.dropdown.binding.auto.get();
ScatterX.API.dropdown.binding.auto.set(true);
Name Type Required Description
value Boolean O 자동 바인딩 사용 여부를 나타내는 값
(기본값 : false)
3. Popup
팝업과 관련된 기능을 사용할 수 있다.
  • Open
  • Connect
  • Data Store
  • Template
  • Share
  • Worklist
3-1. Open
Open (파일 열기) 기능과 관련된 팝업을 열고 닫을 수 있다.
ScatterX.API.open.popup.open(selector);

ScatterX.API.open.popup.open("#app");
ScatterX.API.open.popup.close();
3-2. Connect
Connect (연결) 기능과 관련된 팝업을 열고 닫을 수 있다.
ScatterX.API.connect.popup.open(selector);

ScatterX.API.connect.popup.open("#app");
ScatterX.API.connect.popup.close();
3-3. Data Store
Data Store (데이터 스토어) 기능과 관련된 팝업을 열 수 있다.
ScatterX.API.dataStore.popup.openAsGallery(selector);

ScatterX.API.dataStore.popup.openAsGallery("#app");
ScatterX.API.dataStore.popup.openAsAnalytics(selector);

ScatterX.API.dataStore.popup.openAsAnalytics("#app");
3-4. Favorite
Favorite (즐겨찾기) 기능과 관련된 팝업을 열고 닫을 수 있다.
(*ScatterX.chart API가 선행되어야 사용할 수 있음)
ScatterX.API.favorite.popup.open(chart_type);

ScatterX.API.favorite.popup.open("scatter");
ScatterX.API.favorite.popup.close();
3-5. Template
Template (템플릿) 기능과 관련된 팝업을 열고 닫을 수 있다.
ScatterX.API.template.popup.open(selector);

ScatterX.API.template.popup.open("#app");
ScatterX.API.template.popup.close();
3-6. Share
Share (공유) 기능과 관련된 팝업을 열고 닫을 수 있다.
ScatterX.API.share.popup.open(selector);

ScatterX.API.share.popup.open("#app");
ScatterX.API.share.popup.close();
3-7. Worklist
Worklist (워크리스트) 기능과 관련된 팝업을 열고 닫을 수 있다.
ScatterX.API.worklist.popup.open(selector);

ScatterX.API.worklist.popup.open("#app");
ScatterX.API.worklist.popup.close();
4. Theme
테마를 설정할 수 있다.
ScatterX.API.theme.get();
ScatterX.API.theme.set("dark");
Name Type Required Description
value String O 테마를 나타내는 문자열
(기본값 : light)
  • light
  • dark
  • dark_blue
// 현재 설정된 테마 적용
ScatterX.API.theme.apply();

// 차트 옵션을 포함한 현재 테마 적용
ScatterX.API.theme.apply(true);
Name Type Required Description
includeChartOptions Boolean X 차트 옵션에도 테마를 적용할지 여부를 나타내는 값
(기본값 : false)
사용 가능한 테마를 확인할 수 있다.
ScatterX.API.theme.availables();
사용 가능한 테마의 추가, 삭제를 설정할 수 있다.
ScatterX.API.theme.add("custom");
ScatterX.API.theme.delete("custom");
Name Type Required Description
value String O 추가, 삭제할 테마 이름을 나타내는 값
(*테마 컴포넌트 필요)
5. Language
사용 언어를 설정할 수 있다.
ScatterX.API.language.get();
ScatterX.API.language.set("ko");
Name Type Required Description
value String O 언어 코드를 나타내는 문자열
  • en
  • ko
현재 설정된 언어를 적용할 수 있다.
ScatterX.API.language.apply();
6. Contextmenu
마우스 우클릭 메뉴에 대한 설정을 할 수 있다.
  • Top
  • Bottom
6-1. Contextmenu > Top
마우스 우클릭 메뉴 상단에 대한 설정을 할 수 있다.
ScatterX.API.contextmenu.top.get();
ScatterX.API.contextmenu.top.set(["new_contextmenu"]);
Name Type Required Description
menu Array O 상단 메뉴를 나타내는 배열
6-2. Contextmenu > Bottom
마우스 우클릭 메뉴 하단에 대한 설정을 할 수 있다.
ScatterX.API.contextmenu.bottom.get();
ScatterX.API.contextmenu.bottom.set(["new_contextmenu"]);
Name Type Required Description
menu Array O 상단 메뉴를 나타내는 배열
7. Callbacks
콜백을 지원하는 API에 대한 설정을 할 수 있다.
  • Contextmenu
  • Tool
7-1. Contextmenu
마우스 우클릭 메뉴에 대한 콜백 설정을 할 수 있다.
(*사용자 커스텀 메뉴에 한함)
ScatterX.API.contextmenu.callback.get(key);
Name Type Required Description
key String O 콜백 키를 나타내는 문자열
ScatterX.API.contextmenu.callback.set(key, function);
Name Type Required Description
key String O 콜백 키를 나타내는 문자열
function Function O 콜백을 나타내는 함수
*Argument Format : JSON 문자열
(Object = { key: key, data: Marker/Color/Shape items, xaxis: x column })
ScatterX.API.contextmenu.callback.delete(key);
Name Type Required Description
key String O 콜백 키를 나타내는 문자열
ScatterX.API.contextmenu.callback.reset();
7-2. Tool
차트 도구에 대한 콜백 설정을 할 수 있다.
  • Selection
7-2-1. Tool > Selection
Selection 도구에 대한 콜백 설정을 할 수 있다.
ScatterX.API.tool.selection.callback.set(function);
Name Type Required Description
function Function O 콜백을 나타내는 함수
*Argument : Marker/Color/Shape items
ScatterX.API.tool.selection.callback.reset();
7-3. Draw
차트 그리기에 대한 콜백을 설정할 수 있습니다.
  • Start
  • Complete
  • Cancel
7-3-1. Draw > Start
차트 그리기를 시작할 때의 콜백 설정을 할 수 있다.
ScatterX.API.draw.start.callback.set(function);
Name Type Required Description
function Function O 콜백을 나타내는 함수
*Argument : Data Table Name
ScatterX.API.draw.start.callback.reset();
7-3-2. Draw > Complete
차트 그리기가 완료된 후의 콜백 설정을 할 수 있다.
ScatterX.API.draw.complete.callback.set(function);
Name Type Required Description
function Function O 콜백을 나타내는 함수
*Argument : Job Id
ScatterX.API.draw.complete.callback.reset();
7-3-3. Draw > Cancel
차트 그리기를 취소할 때의 콜백 설정을 할 수 있다.
ScatterX.API.draw.cancel.callback.set(function);
Name Type Required Description
function Function O 콜백을 나타내는 함수
*Argument : Job Id
ScatterX.API.draw.cancel.callback.reset();